| Topic | Badge(s) |
|---|---|
| General | |
| GitHub release | |
| Available on | |
| Compliance | |
| References |
refineGEMs
refineGEMs is a python package intended to help with the curation of genome-scale metabolic models (GEMS).
Overview
Currently refineGEMs can be used for the investigation of a genome-scale metabolic model (GEM)/multiple GEMs, it can complete the following tasks:
- Loading GEMs with
COBRApyandlibSBML - Report and visualise number of metabolites, reactions and genes
- Report orphaned, deadends and disconnected metabolites
- Report mass and charge unbalanced reactions
- Report the Memote score and provide a whole MEMOTE report
- Find and fill gaps automatically via databases like KEGG, BioCyc, SwissProt or a user-defined database
- Compare the charges and masses of the metabolites present in the model to the charges and masses denoted in the ModelSEED Database.
Other applications of refineGEMs to curate a given model include:
- The correction of a model created with CarveMe v1.5.1 or v1.5.2 (for example moving all relevant information from the notes to the annotation field or automatically annotating the GeneProduct section of the model with the respective NCBI gene/protein identifiers from the GeneProduct identifiers)
- The addition of KEGG Pathways as Groups (using the libSBML Groups Plugin)
- Updating the SBO-Term annotations based on SBOannotator
Installation
The toolbox refineGEMscan be installed via pip or via Docker.
Via pip
You can install refineGEMs via pip:
pip install refineGEMs
or to a local conda environment where refineGEMs is distributed via this GitHub repository and all dependencies are denoted in the pyproject.toml file:
# clone or pull the latest source code
git clone https://github.com/draeger-lab/refinegems.git
cd refinegems
conda create -n <EnvName> python=3.10 (at least but < 3.13)
conda activate <EnvName>
# check that pip comes from <EnvName>
which pip
pip install .
Optional features require additional packages that are not needed for the base installation:
# ChEBI lookups
pip install "refineGEMs[chebi]"
# SBO label lookup via OLS
pip install "refineGEMs[ols]"
# SBO annotation
pip install "refineGEMs[sbo]"
# install all optional dependencies
pip install "refineGEMs[optional]"
Via Docker
refineGEMs can also be used via Docker.
You can pull the latest image from (a) Docker Hub or (b) build it locally.
(a) Image from Docker Hub
To pull the image from Docker Hub, simply use:
docker pull biodatalab/refinegems:<tag>
(b) Local build
To build the Docker image locally, firstly clone the repository:
git clone "https://github.com/draeger-lab/refinegems.git"
Then change into the directory and build the image:
cd refinegems
docker build -t refinegems .
The default image installs the runtime optional dependency group from
pyproject.toml, but excludes the documentation dependencies. Optional
connected tools that are currently installed directly from GitHub are included
by default and can be disabled for a smaller image:
# build without the optional connected GitHub tools
docker build \
--build-arg INSTALL_EXTERNAL_TOOLS=false \
-t refinegems:runtime .
The full default can also be made explicit:
docker build \
--build-arg INSTALL_EXTERNAL_TOOLS=true \
-t refinegems:full .
How to use
The default command executed by the image is refinegems -h and provides the help information for the CLI of
refineGEMs.
docker run refinegems -h
To use the image interactively and open a bash shell, run the following command:
docker run -it --entrypoint bash refinegems
To use the image for specific commands, you can simply use every of the CLI commands as entrypoint. For example, to curate a (draft) model, run:
docker run --name <container_name> -v <user_folder>:/rg_cont refinegems analyse stats ./path/to/model.xml
Contributing
Contributions are welcome from users, developers, model curators, and documentation writers. Please read the contributing guide before opening larger changes. It describes the recommended development workflow, coding and documentation standards, media database notes, review process, and pull request checklist.
GitHub issue forms are available for
bug reports
and
feature requests.
Pull requests should target the dev branch and use the repository
pull request template. Please also follow
the project code of conduct.
Licence
The refineGEMs source code is distributed under the MIT licence. Bundled third-party data, database identifiers, adapted code, and connected external tools remain under their own licences or terms; see THIRD_PARTY_LICENSES.md for details.
Logo licence and brand usage
The refineGEMs logos are licensed separately from the source code under the Creative Commons Attribution 4.0 International Licence (CC BY 4.0). The asset-side notice is stored at docs/source/images/logos/LOGO_LICENSE.md.
For colours, minimum size, clear space, and acceptable modifications, see the brand usage guide.
Documentation graphics licence
Project-created documentation graphics are licensed separately from the source code under the Creative Commons Attribution 4.0 International Licence (CC BY 4.0). The asset-side notice is stored at docs/source/images/GRAPHICS_LICENSE.md. Third-party graphics are excluded unless explicitly listed there or accompanied by a compatible notice.
How to cite
When using refineGEMs, please cite the latest publication:
Famke Bäuerle, Gwendolyn O. Döbel, Laura Camus, Simon Heilbronner, and Andreas Dräger. Genome-scale metabolic models consistently predict in vitro characteristics of Corynebacterium striatum. Front. Bioinform., oct 2023. doi:10.3389/fbinf.2023.1214074.
Repositories using refineGEMs
- C_striatum_GEMs
- draeger-lab/Cacnes -
private - draeger-lab/Cgranulosum -
private - draeger-lab/Koxytoca -
private - draeger-lab/Mfortuitum -
private - draeger-lab/Scohnii -
private - draeger-lab/Shaemolyticus -
private - draeger-lab/Ssanguinis -
private
Metadata
Release files for refineGEMs 2.0.0
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 |
|---|---|---|---|---|
| refinegems-2.0.0.tar.gz | 7.2 MB | Without provenance | Details for refinegems-2.0.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| refinegems-2.0.0-py3-none-any.whl | Python 3 | none | any | Details for refinegems-2.0.0-py3-none-any.whl |
Total release size: 14.5 MB
Release files / refinegems-2.0.0.tar.gz
| Download URL | refinegems-2.0.0.tar.gz |
|---|---|
| Size | 7.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c53215eaeb14fdef47929ab8198fbe7ef1ffe28997a85773a456cf6145eb6fdc
|
|
BLAKE2b-256 checksum How to use checksums |
14aac237db4957184de321db814047cbf3e6b50e637c2a75ef8db2f78c71ebe7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / refinegems-2.0.0-py3-none-any.whl
| Download URL | refinegems-2.0.0-py3-none-any.whl |
|---|---|
| Size | 7.2 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c5583d004416a706792cc51ef58cb5bf03d45245fba7289af7c18dc1bda6edab
|
|
BLAKE2b-256 checksum How to use checksums |
0b0b3c5c36147ff2109e5a7b99688ab2cb65d488bba3dcd81d95438d4734373d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for refineGEMs 2.0.0
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.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A 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.