Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
PyHMMER
Manage
Activity
Members
Labels
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Martin Larralde
PyHMMER
Commits
0ec1eefd
Commit
0ec1eefd
authored
8 months ago
by
Martin Larralde
Browse files
Options
Downloads
Patches
Plain Diff
Use `sphinx-design` to summarize features in docs [ci skip]
parent
4efc69b6
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Pipeline
#61987
skipped
Changes
4
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
Showing
4 changed files
README.md
+1
-1
1 addition, 1 deletion
README.md
docs/conf.py
+1
-0
1 addition, 0 deletions
docs/conf.py
docs/index.rst
+36
-28
36 additions, 28 deletions
docs/index.rst
docs/requirements.txt
+1
-0
1 addition, 0 deletions
docs/requirements.txt
with
39 additions
and
29 deletions
README.md
+
1
−
1
View file @
0ec1eefd
...
...
@@ -50,7 +50,7 @@ HMMER internals, which has the following advantages over CLI wrappers
loaded in memory, for instance because you obtained them from another
Python library (such as
[
Pyrodigal
](
https://github.com/althonos/pyrodigal
)
or
[
Biopython
](
https://biopython.org/
)
).
-
**no output
formatt
ing**
: HMMER3 is notorious for its numerous output files
-
**no output
pars
ing**
: HMMER3 is notorious for its numerous output files
and its fixed-width tabular output, which is hard to parse (even
[
`Bio.SearchIO.HmmerIO`
](
https://biopython.org/docs/dev/api/Bio.SearchIO.HmmerIO.html
)
is struggling on some sequences).
...
...
This diff is collapsed.
Click to expand it.
docs/conf.py
+
1
−
0
View file @
0ec1eefd
...
...
@@ -71,6 +71,7 @@ extensions = [
"
sphinx.ext.mathjax
"
,
"
sphinx.ext.todo
"
,
"
sphinx.ext.extlinks
"
,
"
sphinx_design
"
,
"
sphinxcontrib.jquery
"
,
"
nbsphinx
"
,
"
recommonmark
"
,
...
...
This diff is collapsed.
Click to expand it.
docs/index.rst
+
36
−
28
View file @
0ec1eefd
...
...
@@ -76,34 +76,42 @@ the `Eddy/Rivas Laboratory <http://eddylab.org/>`_ at Harvard University.
language, that provides bindings to HMMER3. It directly interacts with the
HMMER internals, which has the following advantages over CLI wrappers:
- **single dependency**:
If your software or your analysis pipeline is
distributed as a Python package, you can add `pyhmmer` as a dependency to
your project, and stop worrying about the HMMER binaries being properly
setup on the end-user machine.
- **no intermediate files**:
Everything happens in memory, in Python objects
you have control on, making it easier to pass your inputs to HMMER without
needing to write them to a temporary file. Output retrieval is also done
in memory, via instances of the `pyhmmer.plan7.TopHits` class.
- **no input formatting**:
The Easel object model is exposed in the `pyhmmer.easel` module, and you
have the possibility to build a `~pyhmmer.easel.Sequence` object yourself to
pass to the HMMER pipeline. This is useful if your sequences are already
loaded in memory, for instance because you obtained them from another
Python library (such as `Pyrodigal <https://github.com/althonos/pyrodigal>`_
or `Biopython <https://biopython.org/>`_).
- **no output formatting**:
HMMER3 is notorious for its numerous output files
and its fixed-width tabular output, which is hard to parse (even
`Bio.SearchIO.HmmerIO` is struggling on some sequences).
- **efficient**:
Using `pyhmmer` to launch ``hmmsearch`` on sequences and HMMs in disk storage
is typically faster than directly using the ``hmmsearch`` binary.
`pyhmmer.hmmer.hmmsearch` uses a different parallelisation strategy compared to
the ``hmmsearch`` binary from HMMER, which helps getting the most of
multiple CPUs.
.. grid:: 1 2 3 3
.. grid-item-card:: :fas:`battery-full` Batteries-included
Just install ``pyhmmer`` as a ``pip`` or ``conda`` dependency, no need
for the HMMER binaries or any other dependency.
.. grid-item-card:: :fas:`screwdriver-wrench` Flexible
Create input `~pyhmmer.easel.Sequence` and `~pyhmmer.plan7.HMM` objects
with the :doc:`API <api/index>`, or load them from a file.
.. grid-item-card:: :fas:`gears` Practical
Retrieve nested results as dedicated `~pyhmmer.plan7.TopHits` objects,
write them to a file, or use them for further Python analysis.
.. grid-item-card:: :fas:`gauge-high` Fast
Run `hmmsearch` in parallel using an efficient threading model, which
:doc:`outperforms <guide/benchmarks>` HMMER in some typical usecases.
.. grid-item-card:: :fas:`dolly` Shareable
:doc:`Distribute <examples/embed_hmms> and load` `~pyhmmer.plan7.HMM`
from inside a Python package to facilitate sharing analyses.
.. grid-item-card:: :fas:`dolly` Distributable
:doc`Distribute <examples/embed_hmms>` and load `HMM` next
in Python package to facilitate sharing and improve reproducibility.
.. grip-item-card:: :fas:`eye` Inspectable
Access the internals of a `~pyhmmer.plan7.HMM`, inspect the attributes
and manually edit transitions or emissions scores.
Setup
-----
...
...
@@ -129,7 +137,7 @@ Library
:maxdepth: 2
User Guide <guide/index>
Examples <examples/index>
..
Examples <examples/index>
API Reference <api/index>
Related Projects
...
...
This diff is collapsed.
Click to expand it.
docs/requirements.txt
+
1
−
0
View file @
0ec1eefd
...
...
@@ -11,6 +11,7 @@ ipython ~=7.19
pygments ~=2.4
nbsphinx ~=0.5
sphinxcontrib-jquery ~=4.1
sphinx-design
pydata-sphinx-theme
# dependencies to run the example notebook(s)
...
...
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment