Skip to main content

A package for decoding RNA cap types

Project description

capfinder

PyPI PyPi Downloads CI/CD PyPI - Python Version PyPI - License


Documentation: https://adnaniazi.github.io/capfinder

Source Code: https://github.com/adnaniazi/capfinder

PyPI: https://pypi.org/project/capfinder/


A package for decoding RNA cap types

Installation

CPU installation

pip install capfinder[cpu]

GPU installation (CUDA 12)

pip install capfinder[gpu] "jax[cuda12]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

TPU installation

pip install capfinder[tpu] "jax[tpu]" -f https://storage.googleapis.com/jax-releases/libtpu_releases.html

Development

  • Clone this repository
  • Requirements:
  • Create a virtual environment and install the dependencies

CPU installation

poetry install --extras cpu

GPU installation (CUDA 12)

poetry install --extras gpu
poetry run pip install "jax[cuda12]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html

TPU installation

poetry install --extras tpu
poetry run pip install "jax[tpu]" -f https://storage.googleapis.com/jax-releases/libtpu_releases.html
  • Activate the virtual environment
poetry shell

Testing

pytest

Documentation

The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github project page automatically as part each release.

Releasing

Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.

Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release and deploys updated documentation.

Pre-commit

Pre-commit hooks run all the auto-formatters (e.g. black, isort), linters (e.g. mypy, flake8), and other quality checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

pre-commit install

Or if you want them to run only for each push:

pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

pre-commit run --all-files

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

capfinder-0.1.5.tar.gz (46.7 kB view details)

Uploaded Source

Built Distribution

capfinder-0.1.5-py3-none-any.whl (55.7 kB view details)

Uploaded Python 3

File details

Details for the file capfinder-0.1.5.tar.gz.

File metadata

  • Download URL: capfinder-0.1.5.tar.gz
  • Upload date:
  • Size: 46.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1022-azure

File hashes

Hashes for capfinder-0.1.5.tar.gz
Algorithm Hash digest
SHA256 150a458b08d0a2730a7b65acff34329d0abc8e8bbda33b79ff6ea30b08775621
MD5 28e357c68c0646dcdfc565ebc89c2315
BLAKE2b-256 603a29744d26840209e948762e74de2b71476c22da5094114b109961b0c6bcfb

See more details on using hashes here.

File details

Details for the file capfinder-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: capfinder-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 55.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.9.19 Linux/6.5.0-1022-azure

File hashes

Hashes for capfinder-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 ed0955515c3c0aafbfd239323e2200b9482ee8f634df4f5a080054bb6e46b6ea
MD5 e696874df931419df20adc880a41a9cd
BLAKE2b-256 009c4d40cd810bae14e8101f0be0ffccd4d8d85e1f81667e2b12bf6cce362819

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page