GeKiM (Generalized Kinetic Modeler)
Description
GeKiM (Generalized Kinetic Modeler) is a Python package designed for creating, interpreting, and modeling arbitrary kinetic schemes. Schemes are defined by the user in a dictionary of species and transitions, which is used to initialize an instance of the System class. Choose (or make) and initialize a simulator for the instance and run it. Field-specific practices are found in gekim/fields.
Installation
With pip:
pip install gekim
Or directly from the source code:
git clone https://github.com/kghaby/GeKiM.git
cd GeKiM
pip install --editable .
Usage
Here is a basic example of how to use GeKiM to create and simulate a kinetic system:
import gekim as gk
from gekim.fields.bio.enzyme.inhib import irrev as ii
# Define your kinetic scheme in a configuration dictionary
concI0,concE0 = 100,1
scheme = {
'species': {
"I": {"y0": concI0, "label": "I"},
"E": {"y0": concE0, "label": "E"},
"EI": {"y0": 0, "label": "EI"},
"E-I": {"y0": 0, "label": "E-I"},
},
'transitions': {
"kon": {"k": 0.01, "source": ["E","2I"], "target": ["EI"]},
"koff": {"k": 0.1, "source": ["EI"], "target": ["E","2I"]},
"kinact": {"k": 0.01, "source": ["EI"], "target": ["E-I"]}, # irreversible step
}
}
# Initialize a system with your schematic dictionary
system = gk.System(scheme, quiet=False)
# Choose a simulator and go
# In this example we're doing a deterministic
# simulation of the concentrations of each species over time.
sim = system.set_simulator(gk.simulators.ODESolver)
sim.simulate() # Note the lack of time-scale input. It's predicted!
# Fit the data to experimental models to extract mock-experimental measurements
t = system.simout["t"]
final_state = system.species["E-I"].simout["y"]
all_bound = system.sum_species_simout(blacklist=["E","I"])
fit_output = ii.kobs_uplim_fit_to_occ_final_wrt_t(
t, final_state,
nondefault_params={"Etot":{"value":concE0, "vary":False}})
For more detailed examples, please refer to the examples directory.
Documentation
Documentation pages are pending, but the functions have docstrings.
Example Jupyter Notebooks where GeKiM has been applied to model and analyze irreversible enzyme inhibition:
Contributing
If you have suggestions or want to contribute code, please feel free to open an issue or a pull request.
License
GeKiM is licensed under MIT.
Contact
Citation
If you use this software, please cite:
Ghaby, K.; Roux, B. Kinetic Modeling of Covalent Inhibition: Effects of Rapidly Fluctuating Intermediate States. J. Chem. Inf. Model. 2025. https://doi.org/10.1021/acs.jcim.5c00952
Metadata
Release files for gekim 0.7.11
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| gekim-0.7.11.tar.gz | 48.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| gekim-0.7.11-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 107.5 kB
Release files / gekim-0.7.11.tar.gz
| Download URL | gekim-0.7.11.tar.gz |
|---|---|
| Size | 48.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1a61ec117196bb956adfd5b8acdaced6027d705f4fba240aa06550a027af8199
|
|
BLAKE2b-256 checksum How to use checksums |
e6dfe011a0021811f00f6859bf0995006bb888699ce61a4c3743a8f168f9a695
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.2
|
Release files / gekim-0.7.11-py3-none-any.whl
| Download URL | gekim-0.7.11-py3-none-any.whl |
|---|---|
| Size | 59.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
576186504d390b751f7a48d58ac5ff0797e50b5c1114d349f35c8b1a5a5eecbb
|
|
BLAKE2b-256 checksum How to use checksums |
9b83e81f7b16dbf014c4f3e65be42aecb0ac3bf4d1cab5ddfcdc10d08a642ad1
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.13.2
|