Skip to main content

Simplified COPASI interface for python

Project description

Python package Documentation Status Quality Gate Status Binder DOI codecov DOI

BasiCO

This project hosts a simplified python interface to COPASI. While all functionality from COPASI is exposed via automatically generated SWIG wrappers, this package aims to add a layer on top of that, to hide most of the complexity away when calling COPASI functions.

COPASI Logo

Installation

The package works with python 3.7+, provided the following packages are installed:

  • python-copasi
  • pandas
  • numpy
  • matplotlib
  • PyYAML

that are freely available on pypi, they will be automatically installed when installing via setup.py.

Once done, just have the basico directory in the PYTHONPATH or sys.path.

Or you could directly install everything you need right from pypi

pip install copasi-basico

from this git repo:

pip install git+https://github.com/copasi/basico.git

Usage

The following modules are available:

  • model_io: functionality, for creating / loading / saving models.
  • model_info: functionality to getting / setting model elements from pandas dataframes
  • task_timecourse: a wrapper for running time course simulations
  • task_parameter_estimation: a wrapper for parameter estimation
  • task_optimization: a wrapper for computing optimizations with arbitrary objective functions
  • task_steadystate: a wrapper for computing steady states
  • task_scan: a wrapper for parameter scans / repeats
  • task_sensitivities: a wrapper for computing sensitivities
  • compartment_array_tools: utility for plotting and the like

Documentation is continually updated at: https://basico.readthedocs.org/.

Please use the issue tracker for bug reports and feature requests.

Run the tests

basico comes with a number of unit tests based on pytest. To run them, change to the root directory of this project and run:

python3 -m pytest

that will ensure that basico is in the python path, and the test run as expected. Some tests require more data, that is not included in the repository, such as tests for PEtab and petab select, for those, specify the environment variables to the directories where the files are for example:

PETAB_BENCHMARK_MODELS=/path/to/petab/benchmark/models
PETAB_SELECT_MODELS=/path/to/petab/select/models

for example:

PETAB_BENCHMARK_MODELS=../Benchmark-Models-PEtab/Benchmark-Models PETAB_SELECT_MODELS=../petab_select/test_cases  python3 -m pytest

Acknowledgements

This project has been possible thanks to the BMBF funded de.NBI initiative (031L0104A):

de.NBI logo

License

The packages available on this page are provided under the Artistic License 2.0, which is an OSI approved license. This license allows non-commercial and commercial use free of charge.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

copasi_basico-0.61.tar.gz (207.5 kB view details)

Uploaded Source

Built Distribution

copasi_basico-0.61-py3-none-any.whl (182.3 kB view details)

Uploaded Python 3

File details

Details for the file copasi_basico-0.61.tar.gz.

File metadata

  • Download URL: copasi_basico-0.61.tar.gz
  • Upload date:
  • Size: 207.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for copasi_basico-0.61.tar.gz
Algorithm Hash digest
SHA256 a8bb1dc8f04a9519e1707b8158e052fde9b4d4ffc6596e213665ab73ab8cb59c
MD5 6967c3a98367b88cacf33504141e538b
BLAKE2b-256 7445b62a0bad3875337dde81646325f81e93bda0a6e284bc1197b3e5c8d1656f

See more details on using hashes here.

File details

Details for the file copasi_basico-0.61-py3-none-any.whl.

File metadata

  • Download URL: copasi_basico-0.61-py3-none-any.whl
  • Upload date:
  • Size: 182.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for copasi_basico-0.61-py3-none-any.whl
Algorithm Hash digest
SHA256 6409fa8de071c5fbed9c28a736d6291ab84a32e5b20e4f2d2de121511597424b
MD5 374f5588c2c5a1e2a20a70395ab88b48
BLAKE2b-256 e4d592d00b6bd3d0488ae2bc8a17f676cad808a0aaa428220e5c356d5543ac14

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page