Tutorial Jupyter notebooks
      Accessing model components Example applications
        Initiating and results handeling Growth-optimal configurations Cellular trade-offs Sensitivity analysis Gene knockout analysis Deriving FBA from RBA
      Adding custom constraints to RBA-problem Linear optimization with rbatools
    Import as library in Python Command line interface Scripts

RBAtools is a Python library, which can be imported and used in scripts and other applications.

Furthermore we provide selected standard workflows as scripts and command line tools, to be used from one's terminal.

To exemplify the capabilities, give inspirations for applications and introduce the user to working with RBAtools, we created extensive Jupyter notebooks as intructional tutorials.

Tutorial Jupyter notebooks:

Our repository includes various instructional jupyter notebooks, exemplifying the use of rbatools.

Please note that the Jupyter notebooks require additional dependencies, not co-installed with rbatools.

Those can be installed with the following commands:

pip install notebook

pip install ipywidgets

pip install matplotlib

pip install seaborn

In order to lauch the jupyter notebook interface, please execute the following command in your terminal:

jupyter notebook

Once a file browser opens in your web browser, please navigate in to the "/tutorials/jupyter_notebooks" sub-directory (in your local clone of the rbatools repository) and doubleclick one of the following notebooks.

Model_components_information_access.ipynb:

This is a Jupyter notebook with example applications on how to access information on model-components and their relationships in the B.subtilis model.

Example_workflows_rba_tools.ipynb:

This is a Jupyter notebook with example applications and workflows of rbatools with B.subtilis model.

Exemplified workflows:

Adding_custom_constraint_to_RBA_problem.ipynb:

This is a Jupyter notebook, where we exemplify how to use rbatools to add user-defined constraints to an RBA-problem. The introduced functionality may serve users to develop more advanced methods with RBA.

Linear_optimization_with_rbatools.ipynb:

This is a Jupyter notebook, exemplifying the use of rbatools to define and solve linear optimization problems. This example is not related to RBA, but uses rbatools functionality to solve an example LP.

Import as library in Python:

When used in own Python code, RBAtools can be imported as follows:

import rbatools

For instructions on usage, please refer to our tutorials and API reference.

Command line interface:

When installing the rbatools library, command line tools for basic applications are co-installed.

run-growth-rate-optimization

This tool runs a growth rate optimisation and stores the obtained results as sbtab. The arguments to provide are an rba-model and the optional arguments for the used lp-solver (default: swiglpk, alternative: cplex) and the path where the results should be stored. To run it, execute the following command in your terminal:

run-growth-rate-optimization path/to/rba/model --lp-solver swiglpk --output-dir ...

generate-sbtab-of-model-for-html

This tool imports an rba-model and exports its component-structure as tabular sbtab (as presented on https://rba.inrae.fr/models) The arguments to provide are an rba-model and the optional argument for the path where the results should be stored. To run it, execute the following command in your terminal:

generate-sbtab-of-model-for-html path/to/rba/model --output-dir ...

Scripts:

We provided scripts with basic functionalities of rbatools in the subdirectory "scripts":

run_growth_rate_optimization.py: This script runs a growth rate optimisation and stores the obtained results as sbtab. The arguments to provide are an rba-model and the optional arguments for the used lp-solver (default: swiglpk, alternative: cplex) and the path where the results should be stored. To run it, execute the following command in your terminal:

python run_growth_rate_optimization.py path/to/model --lp-solver swiglpk --output-dir ...

generate_sbtab_of_model_for_html.py: This script imports an rba-model and exports its component-structure as tabular sbtab (as presented on https://rba.inrae.fr/models) The arguments to provide are an rba-model and the optional argument for the path where the results should be stored. To run it, execute the following command in your terminal:

python generate_sbtab_of_model_for_html.py path/to/model --output-dir ...