Skip to content

Commit

Permalink
add install.rst and update index.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
emmcauley committed Jan 14, 2025
1 parent b9d107a commit 97f4f71
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,6 @@ Documentation Contents
.. toctree::
:maxdepth: 2

install.rst
api.rst

43 changes: 43 additions & 0 deletions docs/install.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
============
Installation
============

1. Install the environment manager :code:`mamba`
2. Install the Python build tool :code:`poetry`

3. Create an environment with Python, Cython, and Pysam:

.. code-block:: bash
mamba env create -f pybwa.yml
4. Activate the environment:

.. code-block:: bash
mamba activate pybwa
5. Clone the :code:`bwa` repo

.. code-block:: bash
git clone https://github.com/lh3/bwa
6. Configure poetry to install into pre-existing virtual environments:

.. code-block:: bash
poetry config virtualenvs.create false
7. Install :code:`pybwa` into the virtual environment:

.. code-block:: bash
poetry install
8. Check your build:

.. code-block:: bash
poetry run pytest

0 comments on commit 97f4f71

Please sign in to comment.