Installation

Requirements

  • Python 3.9 or newer

  • pip ≥ 21

Dependencies installed automatically:

numpy  ≥ 1.24
pandas ≥ 2.0
scipy  ≥ 1.10
matplotlib ≥ 3.7

Installing from PyPI (stable)

pip install opendose-poppk

Installing from source (development)

git clone https://github.com/redkk123/OpenDose-PopPK.git
cd OpenDose-PopPK
pip install -e ".[dev,docs,jupyter]"

Optional dependency groups

Group

Contents

dev

pytest, pytest-cov, black, flake8, mypy

docs

sphinx, sphinx-rtd-theme, myst-parser

jupyter

jupyter, ipython, notebook

Verifying the installation

import opendose_poppk
print(opendose_poppk.__version__)
# 1.1.1

Building the documentation locally

pip install -e ".[docs]"
cd docs
make html
# open docs/_build/html/index.html

Maintainer release workflow (PyPI)

PyPI publication is automated by GitHub Actions using Trusted Publishing (OIDC).

  1. Configure a Trusted Publisher in PyPI for this repository/workflow: - Owner: redkk123 - Repository: OpenDose-PopPK - Workflow: release.yml - Environment: pypi

  2. Bump package version.

  3. Push a tag matching v* (example: v1.0.1).