Skip to main content

GraTools is a powerful and efficient toolkit for working with pangenome graphs,

Project description

GraTools Logo

PyPI version fury.io PyPI license

PyPI pyversions PyPi downloads

GraTools is a powerful tool for analyzing and handling pangenome graphs quickly, whatever the model and therefore the size and the complexity of the GFA file.

It allows users to extract sequences or subgraphs, convert graphs into FASTA sequences, and identify shared and specific nodes across samples. Additionally, it provides essential statistics for chromosomes and samples data. With multi-threading support and flexible logging capabilities, Gratools is an efficient solution for pangenome graph analysis.

GraTools has been developed by IRD and CIRAD, as part of a collaboration between the PANEEC/DIADE and PHIM research teams.

./docs/source/_static/paneec_small.png ./docs/source/_static/ird_small.png ./docs/source/_static/cirad_small.jpg

Documentation

https://gratools.readthedocs.io/en/latest/

Install GraTools

GraTools can be installed like any standard Python package. For a quick start, please refer to the quick start guide in the official documentation.

Using GraTools

Gratools is composed of multiple commands that can be used with the following syntax:

gratools [command] [options]

To view the list of available commands and their descriptions, simply run:

gratools

This will display all the commands supported by Gratools.

For example, to list the chromosomes per sample in a GFA file

gratools show_chr --gfa graph.gfa --full

For more details, refer to the For more details, refer to the Quick Start section or the full command manual in the official documentation. or the full command manual in the official documentation.

Test GraTools with a GFA file

wget http://itrop.ird.fr/GraTools/data-gratools.tar.gz
tar -zxvf data-gratools.tar.gz

Discovering GraSuite

GraTools Logo

GraTools is one of the tools in GraSuite, a comprehensive ecosystem of tools for working with GFA pangenome graphs — from creation to analysis and visualization.

Citation

https://forge.ird.fr/diade/gratools

Maintainer

Authors

  • Sébastien RAVEL (PHIM, CIRAD)

  • Camille CARRETTE (PANEEC/DIADE, IRD/SYNGENTA)

  • Nina MARTHE (PANEEC/DIADE, IRD)

  • Mohamed MOURDAS (PANEEC/DIADE, IRD)

  • François SABOT (PANEEC/DIADE, IRD)

  • Christine TRANCHANT (PANEEC/DIADE, IRD)

Thanks

  • Cécile Triay for the logo.

  • the i-trop plateform, especially Ndomassi Tando, for the support.

License

Licensed under GLPLv3.

Intellectual property belongs to IRD , CIRAD and previously cited authors.

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

gratools-1.0.0.tar.gz (401.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gratools-1.0.0-py3-none-any.whl (143.6 kB view details)

Uploaded Python 3

File details

Details for the file gratools-1.0.0.tar.gz.

File metadata

  • Download URL: gratools-1.0.0.tar.gz
  • Upload date:
  • Size: 401.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for gratools-1.0.0.tar.gz
Algorithm Hash digest
SHA256 01d2f539649f156f18327c4e03abb466df2b78468fc0d9681dd85be1ab8dd613
MD5 54b6ccf86e2a1cdda28f1fb7e6574bc6
BLAKE2b-256 9058f78f1dda84d0b8606fb62efb961be7757988c0cfb501929abdb3a2b8297f

See more details on using hashes here.

File details

Details for the file gratools-1.0.0-py3-none-any.whl.

File metadata

  • Download URL: gratools-1.0.0-py3-none-any.whl
  • Upload date:
  • Size: 143.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.10

File hashes

Hashes for gratools-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6b442c63a6d318eb4637ecda2d252b838e87d01dd6615d807fbbb4d44d1d0cfd
MD5 9cc992c3816ddbc443451815f8ab2ee9
BLAKE2b-256 d6ffaf517e1038fcb9a1895472a5afe832e90e3abe52949f76fad72693623bab

See more details on using hashes here.

Supported by

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