Skip to main content

Helper tools for use with nf-core Nextflow pipelines.

Project description

nf-core/tools

Python tests codecov code style: prettier code style: Ruff

install with Bioconda install with PyPI Get help on Slack

A python package with helper tools for the nf-core community.

The nf-core tools package is written in Python and can be imported and used within other packages. For documentation of the internal Python functions, please refer to the Tools Python API docs.

Installation

For full installation instructions, please see the nf-core documentation. Below is a quick-start for those who know what they're doing:

Bioconda

Install from Bioconda:

conda install nf-core

Alternatively, you can create a new environment with both nf-core/tools and nextflow:

conda create --name nf-core python=3.12 nf-core nextflow
conda activate nf-core

Python Package Index

Install from PyPI:

pip install nf-core

Development version

pip install --upgrade --force-reinstall git+https://github.com/nf-core/tools.git@dev

If editing, fork and clone the repo, then install as follows:

pip install --upgrade -r requirements-dev.txt -e .

Contributions and Support

If you would like to contribute to this package, please see the contributing guidelines.

For further information or help, don't hesitate to get in touch on the Slack #tools channel (you can join with this invite).

Citation

If you use nf-core tools in your work, please cite the nf-core publication as follows:

The nf-core framework for community-curated bioinformatics pipelines.

Philip Ewels, Alexander Peltzer, Sven Fillinger, Harshil Patel, Johannes Alneberg, Andreas Wilm, Maxime Ulysse Garcia, Paolo Di Tommaso & Sven Nahnsen.

Nat Biotechnol. 2020 Feb 13. doi: 10.1038/s41587-020-0439-x.

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

nf_core-3.3.1.tar.gz (555.5 kB view details)

Uploaded Source

Built Distribution

nf_core-3.3.1-py3-none-any.whl (669.5 kB view details)

Uploaded Python 3

File details

Details for the file nf_core-3.3.1.tar.gz.

File metadata

  • Download URL: nf_core-3.3.1.tar.gz
  • Upload date:
  • Size: 555.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nf_core-3.3.1.tar.gz
Algorithm Hash digest
SHA256 ca9e3449419651ee3578a306f13c37986f65a4680ecd33f5fa4d023c80e26ab8
MD5 35dd5034ddb00e7031aab7ffe4768c8f
BLAKE2b-256 185318d446a183270c6d3ab5ad8827debd1961e37d2b3ad08bfcadfa371ea265

See more details on using hashes here.

File details

Details for the file nf_core-3.3.1-py3-none-any.whl.

File metadata

  • Download URL: nf_core-3.3.1-py3-none-any.whl
  • Upload date:
  • Size: 669.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for nf_core-3.3.1-py3-none-any.whl
Algorithm Hash digest
SHA256 666b1a5402b602f4bc4286ad208633498722cd78cc44048de1b5a032601a18da
MD5 0b5cf1b9e05ee04efeadb4f98b55ba48
BLAKE2b-256 c559020ee2c65f8aeff4c1a06ddfff91db6344b04efe79302fa89d04bf5d2f1b

See more details on using hashes here.

Supported by

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