An open API service indexing awesome lists of open source software.

https://github.com/brsynth/rptools

Suite of tools that work on rpSBML format
https://github.com/brsynth/rptools

metabolic-engineering synbio synthetic-biology systems-biology

Last synced: 5 months ago
JSON representation

Suite of tools that work on rpSBML format

Awesome Lists containing this project

README

          

# rpTools

[![Anaconda-Server Badge](https://anaconda.org/brsynth/rptools/badges/latest_release_date.svg)](https://anaconda.org/brsynth/rptools)
[![Anaconda-Server Badge](https://anaconda.org/brsynth/rptools/badges/version.svg)](https://anaconda.org/brsynth/rptools)
![Tests](https://github.com/brsynth/rpTools/workflows/Tests/badge.svg)

rpTools are dedicated to work around rpSBML data structure. Tools are the following:

* rpCompletion: [README.md](rptools/rpcompletion/README.md)
* rpFBA: [README.md](rptools/rpfba/README.md)
* rpThermo: [README.md](rptools/rpthermo/README.md)
* rpExtractSink: [README.md](rptools/rpextractsink/README.md)
* rpLibs: [README.md](rptools/rplibs/README.md)
* rpScore: [README.md](rptools/rpscore/README.md)
* rpRank: [README.md](rptools/rprank/README.md)
* rpViz: [README.md](rptools/rpviz/README.md)
* rpReport: [README.md](rptools/rpreport/README.md)

## Install
```sh
[sudo] conda install -c conda-forge rptools
```

## Run
Please see tool documentation.

## Tests
Test can be run with the following commands:

### Natively
```bash
cd tests
pytest -v
```

## CI/CD
For further tests and development tools, a CI toolkit is provided in `ci` folder (see [ci/README.md](./ci/README.md)).

## For developers

### Development installation

After a git clone:

```sh
cd
conda env create -f environment.yaml -n
conda develop -n .
```

Warning: if you do not specify an environment name with `-n `,
then 'rptools-dev' will be used.

Test your installation with:

```sh
conda activate
python -m rptools
python -m rptools.rpcompletion -h
```

To uninstall:

```sh
conda deactivate
conda env remove -n
```

### Development installation (alternative using the ci toolkit)

After a git clone:
```sh
git clone https://github.com/breakthewall/cicd-toolkit.git
cd cicd-toolkit
make test
cd ..
conda develop -n rptools_test .
```

This will create a `rptools_test` environnement that can be activated to further develop / debug rptools.
```sh
conda activate rptools_test
python -m rptools
python -m rptools.rpcompletion -h
```

## Authors

* **Melchior du Lac**
* **Joan Hérisson**
* **Thomas Duigou**

## Licence
rpTools is released under the MIT licence. See the [LICENCE file](./LICENSE) for details.