Skip to main content

A python package to model dose response dynamics.

Project description

Chi

Unit tests on multiple python versions Unit tests on multiple operating systems codecov Documentation Status DOI

About

Chi is an open source Python package for pharmacokinetic and pharmacodynamic (PKPD) modelling.

All features of the software are described in detail in the full API documentation.

Getting started

Installation

  1. Install sundials

Chi uses the open source package Myokit to solve ordinary differential equations and compute their sensitivities efficiently. Myokit does this using sundials' CVODESS, which needs to be installed with:

  • On Ubuntu:
apt-get install libsundials-dev
  • On MacOS:
brew install sundials
  • On Windows: No action required. Myokit will install sundial automatically.
  1. Install chi
pip install chi-drm

You can now use chi's functionality by importing it

import chi

Tutorials

Tutorials and more detailed explanations on how to use chi can be found in the documentation's getting started section.

Citation

If you use this software in your work, please cite it using the following metadata:

Citation string

Augustin, D., (2024). Chi: A Python package for treatment response modelling. Journal of Open Source Software, 9(94), 5925, https://doi.org/10.21105/joss.05925

BibTeX

@article{
    Augustin2024, 
    doi = {10.21105/joss.05925}, 
    url = {https://doi.org/10.21105/joss.05925}, 
    year = {2024}, 
    publisher = {The Open Journal}, 
    volume = {9}, 
    number = {94}, 
    pages = {5925}, 
    author = {David Augustin}, 
    title = {Chi: A Python package for treatment response modelling}, 
    journal = {Journal of Open Source Software} 
}

Contributing

There are lots of ways how you can contribute to Chi's development, and you are welcome to join in! For example, you can report problems or make feature requests on the issues pages.

Similarly, if you would like to contribute documentation or code you can create and issue, and then provide a pull request for review. To facilitate contributions, we have written extensive contribution guidelines to help you navigate the code.

License

BSD-3-Clause

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

chi_drm-1.0.3.tar.gz (169.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

chi_drm-1.0.3-py3-none-any.whl (190.7 kB view details)

Uploaded Python 3

File details

Details for the file chi_drm-1.0.3.tar.gz.

File metadata

  • Download URL: chi_drm-1.0.3.tar.gz
  • Upload date:
  • Size: 169.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for chi_drm-1.0.3.tar.gz
Algorithm Hash digest
SHA256 ebc1c7853311afbbc1fd0b1ddc31d3f59537d18a938567ae7acc38c8e9456928
MD5 bba6a26458c32fda1f40529fb304ec5c
BLAKE2b-256 1c26ba8d6a111cdfcbaafc227caf0b8f9463f0cf36f54e24abfc0e998973355e

See more details on using hashes here.

File details

Details for the file chi_drm-1.0.3-py3-none-any.whl.

File metadata

  • Download URL: chi_drm-1.0.3-py3-none-any.whl
  • Upload date:
  • Size: 190.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.9.6

File hashes

Hashes for chi_drm-1.0.3-py3-none-any.whl
Algorithm Hash digest
SHA256 293f136baaa79c09fa4c9deb7011f39529978e098c0476d109f4effe5013c1b4
MD5 fb0a89bb8b62db5f8e0b05263335db50
BLAKE2b-256 29fa68eb81523711970e8fc967ae48894981f071e4856e4044e06fba5822cd1f

See more details on using hashes here.

Supported by

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