Beacon v2 CBI Tools
Beacon v2 CBI Tools prepares portable Beacon Friendly Format (BFF) data for Beacon v2. Its command-line interface is called bff-tools. It validates phenotypic and clinical metadata, converts VCF or SNP-array TSV input into BFF genomicVariations, and can generate a standalone browser report.
Beacon v2 CBI Tools is the actively developed continuation of the original beacon2-ri-tools codebase, now developed at CNAG Biomedical Informatics by its original developer.
The two historical image badges preserve the download record of earlier distributions; those images are deprecated for new installations.
The output remains independent of a particular Beacon server or database. For serving, consider the Beacon v2 Production Implementation or bycon.
Read the documentation for installation options, the quick start, the end-to-end tutorial, CLI reference, annotation resources, and troubleshooting.
Install
python3 -m pip install beacon2-cbi-tools
Python 3.10 through 3.14 is supported. Docker, Apptainer, and source/HPC instructions are available in the installation guide.
Check the installation and run the packaged example without downloading annotation databases:
bff-tools doctor
bff-tools demo
Data flow
Roadmap
- Follow Beacon v2 developments, including VRS alignment.
- Move to Beacon v3 once the specification is finalized.
Citation
If you use these tools in published work, please cite:
Rueda M, Ariosa R. "Beacon v2 Reference Implementation: a toolkit to enable federated sharing of genomic and phenotypic data." Bioinformatics, btac568. https://doi.org/10.1093/bioinformatics/btac568
License
Written by Manuel Rueda, PhD, at CNAG Biomedical Informatics. Licensed under the GNU General Public License v3.0 or later; see LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for beacon2-cbi-tools 2.0.13
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| beacon2_cbi_tools-2.0.13.tar.gz | 3.6 MB | With provenance | Details for beacon2_cbi_tools-2.0.13.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| beacon2_cbi_tools-2.0.13-py3-none-any.whl | Python 3 | none | any | Details for beacon2_cbi_tools-2.0.13-py3-none-any.whl |
Total release size: 7.3 MB
Release files / beacon2_cbi_tools-2.0.13.tar.gz
| Download URL | beacon2_cbi_tools-2.0.13.tar.gz |
|---|---|
| Size | 3.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
881c66a298aa902ac8523afcc2308b1ef76e5a9b3274372063548cec9c3c9bd1
|
|
BLAKE2b-256 checksum How to use checksums |
07c991451f156a5cada35bc3474266303b9b3ce7bc655ee9c13d81cce450d6c5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 20, 2026.
Transparency logRelease files / beacon2_cbi_tools-2.0.13-py3-none-any.whl
| Download URL | beacon2_cbi_tools-2.0.13-py3-none-any.whl |
|---|---|
| Size | 3.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
cf2d7ee3483dabadce5dbae3ce582af886772b71f55be9e9af53a007b4a3a7c6
|
|
BLAKE2b-256 checksum How to use checksums |
42ac0cf2b4daf61d2f15f79143f7dd7e6dc5701d3c19cf509639bcb9fc0b7d13
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 20, 2026.
Transparency logSecurity for beacon2-cbi-tools 2.0.13
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for beacon2_cbi_tools-2.0.13.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jul 20, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
