Bycon - a Python-based full stack environment for the Beacon genomics API
The bycon project implements a data hosting environment for genomic and pheno-clinical data aligned with the GA4GH Beacon data model. It provides a Beacon API for data query and retrieval but also has extended functionality with a focus on genomic copy number variation data. For a prominent implementation example showcasing bycon features please see the Progenetix oncogenomic resource.
The underlying database system utilizes a MongoDB instance and a storage model following for the most part the GA4GH object model.
Additionally, the bycon project implements functions for the ingestion and management of genomic variants and phenoclinical data,
and provides a front end for the Beacon API as a statically compiled React project
("beaconPlus"). An instance of the beaconPlus front end is accessible at beaconplus.progenetix.org.
More Documentation
Documentation has been moved to bycon.progenetix.org.
Due to the rapid code development it is recommended to keep following the Changes
page.
Installation
The preferred method is to modify your local configuration and then perform a
package build and installation running install.sh followed by the deployment
script.
The installation is also documented on the website.
bycon Libraries option 1 using ./install.sh
Since the script only copies the script directories and local configuration
directory to the server path, additionally a bycon package installation is
needed through either local package installation from source (install.sh in the
project's root) or pip3 install bycon>=3.0.0.
bycon Libraries option 2 using pip3 install bycon
The preferred method is to modify your local configuration and then perform a
package build and installation running the install.sh script followed by this
deployment script.
beacon.py Server App using ./scripts/deploy.py
The install script copies the relevant bycon files to the webserver directory
specified in the ../local-settings/env_paths.yaml file and sets the file permissions
accordingly. By default, it requires admin permissions (sudo). If you want to run
it without sudo, invoke it with --no-sudo. The current use will need to be able
to write into the target directories.
1 maintainer
Metadata
1 maintainer
Release files for bycon 3.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| bycon-3.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Release files / bycon-3.3.0-py3-none-any.whl
| Download URL | bycon-3.3.0-py3-none-any.whl |
|---|---|
| Size | 3.1 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
31d6db861c69bb996f084e0498479a87d9632bb81eca469f3bfd98d386edc340
|
|
BLAKE2b-256 checksum How to use checksums |
b1fa928181b525a37ceb9252e7d1025b507c24eb7aecbee4dd30b0ca4c390631
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.14.6
|
