Skip to content

Commit

Permalink
feat: use pybwa
Browse files Browse the repository at this point in the history
  • Loading branch information
nh13 committed Jan 17, 2025
1 parent 4348446 commit cfed0c0
Show file tree
Hide file tree
Showing 10 changed files with 199 additions and 284 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@

## Recommended Installation

The package `prymer` requires installation of [Primer3](https://github.com/primer3-org/primer3) and [interactive `bwa`](https://github.com/fulcrumgenomics/bwa-aln-interactive).
The package `prymer` requires installation of [Primer3](https://github.com/primer3-org/primer3).

To satisfy these requirements, it is recommended to install using [bioconda](https://bioconda.github.io/):

Expand Down
7 changes: 3 additions & 4 deletions docs/installation-and-developers-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,25 +14,24 @@ mamba install -c bioconda prymer

1. Install the environment manager [`mamba`](https://mamba.readthedocs.io/en/latest/installation/mamba-installation.html)
2. Install the Python build tool [`poetry`](https://python-poetry.org/docs/#installing-with-the-official-installer)
3. Create an environment with Python, [Primer3](https://github.com/primer3-org/primer3), and [interactive `bwa`](https://github.com/fulcrumgenomics/bwa-aln-interactive):

```console
mamba env create -y -f prymer.yml
```

4. Activate the environment:
3. Activate the environment:

```console
mamba activate prymer
```

5. Configure `poetry` to install into pre-existing virtual environments:
4. Configure `poetry` to install into pre-existing virtual environments:

```console
poetry config virtualenvs.create false
```

6. Install `prymer` into the virtual environment:
5. Install `prymer` into the virtual environment:

```console
poetry install
Expand Down
58 changes: 36 additions & 22 deletions poetry.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion prymer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,5 @@ channels:
- bioconda
- conda-forge
dependencies:
- bioconda::bwa-aln-interactive=0.7.18
- bioconda::primer3=2.6.1
- conda-forge::python>=3.11.*
4 changes: 2 additions & 2 deletions prymer/offtarget/__init__.py
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
from prymer.offtarget.bwa import BwaAlnInteractive
from prymer.offtarget.bwa import Bwa
from prymer.offtarget.bwa import BwaHit
from prymer.offtarget.bwa import BwaResult
from prymer.offtarget.bwa import Query
from prymer.offtarget.offtarget_detector import OffTargetDetector
from prymer.offtarget.offtarget_detector import OffTargetResult

__all__ = [
"BwaAlnInteractive",
"Bwa",
"Query",
"BwaHit",
"BwaResult",
Expand Down
Loading

0 comments on commit cfed0c0

Please sign in to comment.