Skip to content

Commit

Permalink
docs: add install.rst and update index.rst (#4)
Browse files Browse the repository at this point in the history
* add install.rst and update index.rst
  • Loading branch information
emmcauley authored Jan 15, 2025
1 parent 1ed6ec0 commit 68f6c50
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. Clone the :code:`pybwa` repo (note the :code:`--recurse-submodules` flag, as :code:`bwa` is a submodule)

.. code-block:: bash
git clone --recurse-submodules https://github.com/fulcrumgenomics/pybwa
2. Install the environment manager :code:`mamba`
3. Install the Python build tool :code:`poetry`

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

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

.. code-block:: bash
mamba activate pybwa
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 68f6c50

Please sign in to comment.