Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add install.rst and update index.rst #4

Merged
merged 2 commits into from
Jan 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
============

nh13 marked this conversation as resolved.
Show resolved Hide resolved
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

Loading