HUB
Sign inSign up

biodatalab/specimen

By biodatalab

•Updated 6 days ago

Image
Data science
0

97

biodatalab/specimen repository overview

Logo of SPECIMEN

TopicBadge(s)
GeneralGitHub Licence Python Version from PEP 621 TOML Documentation Status Repo Size GitHub last commit (branch)
GitHub ReleaseGitHub release (with filter) GitHub all releases
ComplianceCode style: black
ReferencesDOI

⁠SPECIMEN

SPECIMEN is a collection of different workflows designed for the automated and standardised curation of genome-scale models. It is mainly based on the refineGEMs toolbox⁠, but also includes additional tools like CarveMe⁠.

Currently avaible workflow:

  • CMPB - CarveMe-ModelPolisher based:\Starting from a CarveMe draft model, refine and extend it towards a high-quality stain-specific model

  • HQTB - High-quality template based:\This pipeline follows the modelling approach of using a high-quality template model as a basis for the reconstruction of a new model from a new genome (e.g. a different strain).

  • :construction: PGAB - Prokaryotic Genome Annotation Pipeline (PGAP)-based: Under construction → see Documentation on ReadTheDocs⁠ or the pgab-dev branch on GitHub⁠

⁠Installation

The workflow collection SPECIMEN can be installed via pip or via Docker.

⁠pypi Via pip

Download this repository and run the command pip install -e . inside the top-level directory.

When running certain steps, further tools need to be installed:

⁠docker Via Docker

SPECIMEN can also be used via Docker. To build the docker image, firstly clone the repository:

   git clone "https://github.com/draeger-lab/specimen.git"

Then change into the directory and build the image:

   cd specimen \
   docker build -t specimen .

⁠Quickstart

⁠pypi After install via pip

After the installation, main functionalities can be accessed via the command line. Try running specimen --help for more information.

For greater control or for further integration into other scripts, the modules of SPECIMEN can be loaded as a Python package as well using import specimen in a Python script.

⁠docker After install via Docker

Note

To provide the input files and retrieve the output files mount one folder as workspace folder to the Docker image with `-v`.

The default command executed by the image is specimen -h and provides the help information for the CLI of SPECIMEN.

   docker run specimen

To use the image interactively and open a bash shell, run the following command:

   docker run -it --entrypoint bash specimen

To use the image for specific commands, you can simply use every of the CLI commands as entrypoint. For example, to run the CMPB pipeline, use:

   docker run --name <container_name> -v <user_folder>:/sp_cont specimen cmpb run ./path/to/CMPB_config.yaml

⁠Documentation

For more information about the available pipelines, the code or for troubleshooting, please refer to the documentation of the tool here⁠.

⁠Contributing

Contributions are welcome! SPECIMEN contributions often involve workflows, configuration templates, documentation, example datasets, pipeline modules, or interfaces to external tools. Please read our Contributing Guide⁠ before opening an issue or submitting a pull request.

For GitHub issues, please use the matching template:

  • Bug report⁠ for reproducible errors, failed pipeline runs, configuration problems, or external-tool issues
  • Feature request⁠ for general improvements to workflows, configuration, documentation, examples, or tool interfaces
  • Workflow suggestion⁠ for new workflow steps, workflow restructuring, or changes that need complete-run validation

Pull requests should follow the pull request template⁠ and describe workflow validation, configuration compatibility, external dependencies, and documentation updates. Please also follow our Code of Conduct⁠.

⁠Repositories using SPECIMEN

  • draeger-lab/Cacnes - private
  • draeger-lab/Cgranulosum - private
  • draeger-lab/Koxytoca - private
  • draeger-lab/Mfortuitum - private
  • draeger-lab/Scohnii - private

Tag summary

Content type

Image

Digest

sha256:5cd9692b8…

Size

706.9 MB

Last updated

6 days ago

docker pull biodatalab/specimen