Skip to content

RytyB/HP-C1Pyr-PK-python

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

HP C1-Pyruvate Pharmacokinetic Modeling Package for Python

Purpose

    This package was meant to create a more user friendly, open source version of the MATLAB code developed by the MD Anderson Magnetic Resonance Engineering Laboratory. The original repository is available at https://github.com/mda-mrsl/HP-C1Pyr-PK
    These scripts calculate the relationship between [1-13C]-pyruvate and [1-13C]-lactate, but can easily be extended to include other metabolites.
    There are three base models or simulators of differing complexity which include a different number of physical compartments:
    The scripts titled P2L3*.py describe signal evolution between two chemical pools and three physical compartments. The three-compartment model is the most physiologically accurate among these models, but it is also the most computationally intensive, requiring the largest number of descriptive parameters.
    The scripts titled P2L2*.py are for the PK model with two chemical pools and two physical compartments. Here, HP pyruvate and lactate in the extravascular/extracellular space is assumed to be very well mixed with HP pyruvate in the intracellular space - and separate from pyr/lac in the vascular supply.
    The scripts titled P2L1*.py represent a simple precursor-product model, which does not consider physical compartmentalization of imaging agents. Equivalently, this assumes that all compartments (vascular; extravascular/extracellular; and cellular) are well mixed.
    There are also Fit and Sim_Data objects, which can be used to generate fitted signal curves to a data set and simulate an experimental dataset respectively.

Installation

    Running requires python version 3.10 or compatible
    Previous version of code can be installed from Pypi repository with pip
    pip install pkhpc1pyr
    The required dependencies can be found in the file requirements.txt and installed with the command
    pip install -r requirements.txt
    The installation can be tested by calling the TestP2L* functions without any arguments. For example:
    import pkhpc1pyr as pk
    pk.tests.TestP2L3()
    Current version of the package will be updated and added to Pypi repository after further testing or upon request.

Contact

    For questions about code or maintenance please contact Ryan Boyce
    rboyce@mdanderson.org
    For further questions about the original MATLAB repository please contact Dr. Jim Bankson
    jbankson@mdanderson.org

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages