README.md

Pharmokinetic Modelling Project

The Pharmokinetic Modelling (PK) Project is a python library that allows pharmacologists and individuals interested in pharmokinetics to solve and visualise the solution of a PK model after specifying a protocol.

Prerequisites

Ensure you have met the following requirements

• You have installed Python 3.5 or latest versions [3.6, 3.7, 3.8]
• OS supported: Windows, Linux, Mac
• You read the documentation

PK Project Installation

To install the PK project, follow the steps:

Linux and MacOS:

Create a virtual environment

$ python3 -m venv venv
$ source bin/activate/venv

Download the repository and move to the PKModelProject folder

$ cd PKModelProject folder

Install the dependencies

$ python3 -m pip install setup.py

Windows:

Create a virtual environment

$ py -m venv venv>

$ .\venv\Scripts\activate

Download the repository and move to the PKModelProject folder

$ cd PKModelProject folder

Install the dependencies

$ py -m pip install setup.py

Usage

$ python3 model.py

Contributing to PK Project

To contribute to the PK project, follow these steps:

1. Fork the repository
2. Create a branch: $ git checkout -b <branch_name>.
3. Once your changes are made, commit them: $ git commit -m '<commit_message>'
4. Push to the original branch: $ git push origin <project_name>/
5. Create the pull request.

Contributors

• Julia Krol
• Alex Tanaka
• Emmanuelle Bourigault
• Emmanuel Oladokun

Licence

This project uses the following license: MIT