Skip to main content
Current PyPI Version Supported Python Versions GPLv3+ Pipeline Status Coverage Report Black

This project provides an object-oriented software package for dynamic flux-balance analysis (DFBA) simulations using implementations of the direct method or Algorithm 1 described in the paper Harwood et al., 2016. The main algorithms for solving embedded LP problems are written in C++ and use the GNU Linear Programming Kit (GLPK) and the Suite of Nonlinear and Differential/Algebraic Equation Solvers (SUNDIALS) CVODE or IDA. Extension modules to cobrapy are provided for easy generation and simulation of DFBA models.

Installation

Currently, we do not provide Python wheels for this package and therefore Installing from source is a bit more involved. The quickest way to run the software is from the provided Docker image:

docker run --rm -it davidtourigny/dfba:latest

Installing from source

Currently this package is compatible with most UNIX-like operating systems. Provided the following Dependencies are installed, the module can be installed from the root of the repository using the command:

pip install .

Dependencies

  • A version of Python 3.6 or higher is required

  • You need cmake for the build process

  • You will need git to clone this repository to access the scripts and build files

  • You need a working compiler with C++11 support, for example, by installing build-essential on Debian-derived Linux systems

  • GLPK version 4.65 is required or can be installed using build_glpk.sh

  • SUNDIALS version 5.0.0 or higher is required or can be installed using build_sundials.sh

  • pybind11 is required or can be installed using build_pybind11.sh

Be aware that some of these packages have their own dependencies that must therefore be installed also (e.g. GLPK depends on GMP and pybind11 requires pytest).

Alternatively, a Dockerfile is provided for building a Docker image to run the software from an interactive container. The Docker image can be built in one step by issuing the command:

make build

from the root of this repository. It can then be started using:

make run

Documentation

Documentation for dfba is provided at readthedocs

Authors

  • David S. Tourigny

  • Moritz E. Beber

Additional contributors

  • Jorge Carrasco Muriel (visualization and documentation)

Funding

  • David S. Tourigny is a Simons Foundation Fellow of the Life Sciences Research Foundation.

Release files for dfba 0.1.8

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for dfba 0.1.8
File Size Uploaded
dfba-0.1.8.tar.gz 63.1 kB Details

Release files / dfba-0.1.8.tar.gz

Download URL dfba-0.1.8.tar.gz
Size 63.1 kB
Tags Source
SHA-256 checksum
How to use checksums
fdeeecab9bfe169c091382195eab32d49545a140e14741d446b4c164a62ec24a
BLAKE2b-256 checksum
How to use checksums
d6cecc1f2ca024c7cde937ca6d9b703c999985d112e6ad42176a78c083570a88
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/50.0.0 requests-toolbelt/0.9.1 tqdm/4.48.2 CPython/3.7.5rc1

Release history Release notifications | RSS feed

This release

0.1.8 This release

1 release file

0.1.6

1 release file

0.1.5

1 release file

0.1.4

1 release file

0.1.3

1 release file

0.1.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page