Installation
============

Regular usage
-------------

Install the latest stable version of PyGenePlexus via
`PyPI <https://pypi.org/project/geneplexus/>`_:

.. code-block:: bash

   pip install geneplexus

Install the latest version of PyGenePlexus directly from source on
`GitHub <https://github.com/krishnanlab/PyGenePlexus>`_:

.. code-block:: bash

   pip install git+https://github.com/krishnanlab/PyGenePlexus.git

Development
-----------

To install the latest PyGenePlexus package in editable mode with dev dependencies

.. code-block:: bash

   git clone git@github.com:krishnanlab/PyGenePlexus.git
   cd PyGenePlexus
   pip install -e ."[dev]"

Install pre-commit hooks to ensure coding style consistency

.. code-block:: bash

   pip install pre-commit
   pre-commit install