mxlmodels 1.0.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- mxlmodels-1.0.0/.gitattributes +9 -0
- mxlmodels-1.0.0/.github/ISSUE_TEMPLATE/bug_report.md +7 -0
- mxlmodels-1.0.0/.github/ISSUE_TEMPLATE/discussion.md +9 -0
- mxlmodels-1.0.0/.github/ISSUE_TEMPLATE/feature_request.md +8 -0
- mxlmodels-1.0.0/.github/dependabot.yml +17 -0
- mxlmodels-1.0.0/.github/workflows/docs.yml +43 -0
- mxlmodels-1.0.0/.github/workflows/python-publish.yml +55 -0
- mxlmodels-1.0.0/.github/workflows/release-to-slack.yml +77 -0
- mxlmodels-1.0.0/.github/workflows/tests.yml +30 -0
- mxlmodels-1.0.0/.gitignore +15 -0
- mxlmodels-1.0.0/.pre-commit-config.yaml +10 -0
- mxlmodels-1.0.0/.python-version +1 -0
- mxlmodels-1.0.0/.vscode/settings.json +63 -0
- mxlmodels-1.0.0/CONTRIBUTING.md +17 -0
- mxlmodels-1.0.0/LICENSE +21 -0
- mxlmodels-1.0.0/PKG-INFO +68 -0
- mxlmodels-1.0.0/README.md +41 -0
- mxlmodels-1.0.0/SECURITY.md +21 -0
- mxlmodels-1.0.0/docs/assets/logo.png +0 -0
- mxlmodels-1.0.0/pyproject.toml +140 -0
- mxlmodels-1.0.0/src/mxlmodels/__init__.py +34 -0
- mxlmodels-1.0.0/src/mxlmodels/dyn_entro.py +184 -0
- mxlmodels-1.0.0/src/mxlmodels/ebeling2026.py +2375 -0
- mxlmodels-1.0.0/src/mxlmodels/lotka_volterra_v1.py +92 -0
- mxlmodels-1.0.0/src/mxlmodels/lotka_volterra_v2.py +83 -0
- mxlmodels-1.0.0/src/mxlmodels/matuszynska2016_npq.py +683 -0
- mxlmodels-1.0.0/src/mxlmodels/matuszynska2016_phd.py +864 -0
- mxlmodels-1.0.0/src/mxlmodels/matuszynska2019.py +1469 -0
- mxlmodels-1.0.0/src/mxlmodels/poolman2000.py +685 -0
- mxlmodels-1.0.0/src/mxlmodels/pop_dyn.py +69 -0
- mxlmodels-1.0.0/src/mxlmodels/py.typed +0 -0
- mxlmodels-1.0.0/src/mxlmodels/saadat2021.py +1871 -0
- mxlmodels-1.0.0/src/mxlmodels/trip_dyn.py +115 -0
- mxlmodels-1.0.0/src/mxlmodels/yokota1985.py +170 -0
- mxlmodels-1.0.0/uv.lock +1502 -0
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# GitHub syntax highlighting
|
|
2
|
+
pixi.lock linguist-language=YAML
|
|
3
|
+
|
|
4
|
+
# proper line endings
|
|
5
|
+
* text=auto eol=lf
|
|
6
|
+
*.{cmd,[cC][mM][dD]} text eol=crlf
|
|
7
|
+
*.{bat,[bB][aA][tT]} text eol=crlf
|
|
8
|
+
# SCM syntax highlighting & preventing 3-way merges
|
|
9
|
+
pixi.lock merge=binary linguist-language=YAML linguist-generated=true
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
version: 2
|
|
2
|
+
|
|
3
|
+
updates:
|
|
4
|
+
- package-ecosystem: "uv"
|
|
5
|
+
directory: "/"
|
|
6
|
+
schedule:
|
|
7
|
+
interval: "weekly"
|
|
8
|
+
day: "monday"
|
|
9
|
+
time: "05:00"
|
|
10
|
+
assignees:
|
|
11
|
+
- "marvinvanaalst"
|
|
12
|
+
commit-message:
|
|
13
|
+
prefix: "build(deps): "
|
|
14
|
+
groups:
|
|
15
|
+
dependencies:
|
|
16
|
+
patterns:
|
|
17
|
+
- "*"
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
name: documentation
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
workflow_dispatch: {}
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: write
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
build-documentation:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
with:
|
|
17
|
+
fetch-depth: 0 # fetch all commits/branches
|
|
18
|
+
|
|
19
|
+
- name: Configure Git Credentials
|
|
20
|
+
run: |
|
|
21
|
+
git config user.name github-actions[bot]
|
|
22
|
+
git config user.email 41898282+github-actions[bot]@users.noreply.github.com
|
|
23
|
+
|
|
24
|
+
- name: Install uv
|
|
25
|
+
uses: astral-sh/setup-uv@v4
|
|
26
|
+
|
|
27
|
+
- name: Set up Python
|
|
28
|
+
run: uv python install 3.13
|
|
29
|
+
|
|
30
|
+
- name: Set Python version
|
|
31
|
+
run: uv venv --python 3.13
|
|
32
|
+
|
|
33
|
+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
|
|
34
|
+
- uses: actions/cache@v4
|
|
35
|
+
with:
|
|
36
|
+
key: mkdocs-material-${{ env.cache_id }}
|
|
37
|
+
path: .cache
|
|
38
|
+
restore-keys: |
|
|
39
|
+
mkdocs-material-
|
|
40
|
+
- run: uv sync --all-extras --all-groups
|
|
41
|
+
- run: uv run python -c "import toml;print('VERSION={}'.format(toml.load(open('pyproject.toml'))['project']['version']))" >> $GITHUB_ENV
|
|
42
|
+
- run: uv run mike deploy --update-aliases --push ${{ env.VERSION }} latest
|
|
43
|
+
- run: uv run mike set-default --push latest
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
name: Upload Python Package
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
workflow_dispatch: {}
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: read
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
release-build:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- name: Install uv
|
|
18
|
+
uses: astral-sh/setup-uv@v4
|
|
19
|
+
|
|
20
|
+
- name: Set up Python
|
|
21
|
+
run: uv python install 3.13
|
|
22
|
+
|
|
23
|
+
- name: Set Python version
|
|
24
|
+
run: uv venv --python 3.13
|
|
25
|
+
|
|
26
|
+
- name: Build release distribution
|
|
27
|
+
run: uv build
|
|
28
|
+
|
|
29
|
+
- name: Upload distributions
|
|
30
|
+
uses: actions/upload-artifact@v4
|
|
31
|
+
with:
|
|
32
|
+
name: release-dists
|
|
33
|
+
path: dist/
|
|
34
|
+
|
|
35
|
+
pypi-publish:
|
|
36
|
+
runs-on: ubuntu-latest
|
|
37
|
+
needs:
|
|
38
|
+
- release-build
|
|
39
|
+
permissions:
|
|
40
|
+
id-token: write
|
|
41
|
+
|
|
42
|
+
environment:
|
|
43
|
+
name: pypi
|
|
44
|
+
|
|
45
|
+
steps:
|
|
46
|
+
- name: Retrieve release distributions
|
|
47
|
+
uses: actions/download-artifact@v4
|
|
48
|
+
with:
|
|
49
|
+
name: release-dists
|
|
50
|
+
path: dist/
|
|
51
|
+
|
|
52
|
+
- name: Publish release distributions to PyPI
|
|
53
|
+
uses: pypa/gh-action-pypi-publish@release/v1
|
|
54
|
+
with:
|
|
55
|
+
packages-dir: dist/
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
name: Notify Slack on Release
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
release:
|
|
5
|
+
types: [published]
|
|
6
|
+
|
|
7
|
+
jobs:
|
|
8
|
+
notify:
|
|
9
|
+
runs-on: ubuntu-latest
|
|
10
|
+
|
|
11
|
+
steps:
|
|
12
|
+
- name: Send release notification to Slack
|
|
13
|
+
env:
|
|
14
|
+
SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
|
|
15
|
+
RELEASE_NAME: ${{ github.event.release.name }}
|
|
16
|
+
RELEASE_TAG: ${{ github.event.release.tag_name }}
|
|
17
|
+
RELEASE_BODY: ${{ github.event.release.body }}
|
|
18
|
+
RELEASE_URL: ${{ github.event.release.html_url }}
|
|
19
|
+
REPO: ${{ github.repository }}
|
|
20
|
+
run: |
|
|
21
|
+
payload=$(jq -n \
|
|
22
|
+
--arg text "*New Release Published* :tada:" \
|
|
23
|
+
--arg repo "$REPO" \
|
|
24
|
+
--arg name "$RELEASE_NAME" \
|
|
25
|
+
--arg tag "$RELEASE_TAG" \
|
|
26
|
+
--arg body "$RELEASE_BODY" \
|
|
27
|
+
--arg url "$RELEASE_URL" \
|
|
28
|
+
'{
|
|
29
|
+
text: $text,
|
|
30
|
+
blocks: [
|
|
31
|
+
{
|
|
32
|
+
type: "section",
|
|
33
|
+
text: {
|
|
34
|
+
type: "mrkdwn",
|
|
35
|
+
text: "*New Release Published* :tada:"
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
type: "section",
|
|
40
|
+
fields: [
|
|
41
|
+
{ type: "mrkdwn", text: "*Repository:*\n\($repo)" },
|
|
42
|
+
{ type: "mrkdwn", text: "*Tag:*\n\($tag)" }
|
|
43
|
+
]
|
|
44
|
+
},
|
|
45
|
+
{
|
|
46
|
+
type: "section",
|
|
47
|
+
text: {
|
|
48
|
+
type: "mrkdwn",
|
|
49
|
+
text: "*Release:*\n\($name)"
|
|
50
|
+
}
|
|
51
|
+
},
|
|
52
|
+
{
|
|
53
|
+
type: "section",
|
|
54
|
+
text: {
|
|
55
|
+
type: "mrkdwn",
|
|
56
|
+
text: "*Notes:*\n\($body)"
|
|
57
|
+
}
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
type: "actions",
|
|
61
|
+
elements: [
|
|
62
|
+
{
|
|
63
|
+
type: "button",
|
|
64
|
+
text: {
|
|
65
|
+
type: "plain_text",
|
|
66
|
+
text: "View Release"
|
|
67
|
+
},
|
|
68
|
+
url: $url
|
|
69
|
+
}
|
|
70
|
+
]
|
|
71
|
+
}
|
|
72
|
+
]
|
|
73
|
+
}')
|
|
74
|
+
|
|
75
|
+
curl -X POST -H 'Content-type: application/json' \
|
|
76
|
+
--data "$payload" \
|
|
77
|
+
"$SLACK_WEBHOOK_URL"
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
name: ci
|
|
2
|
+
|
|
3
|
+
on:
|
|
4
|
+
pull_request:
|
|
5
|
+
branches:
|
|
6
|
+
- main
|
|
7
|
+
|
|
8
|
+
permissions:
|
|
9
|
+
contents: write
|
|
10
|
+
|
|
11
|
+
jobs:
|
|
12
|
+
default-tests:
|
|
13
|
+
runs-on: ubuntu-latest
|
|
14
|
+
steps:
|
|
15
|
+
- uses: actions/checkout@v4
|
|
16
|
+
|
|
17
|
+
- name: Install uv
|
|
18
|
+
uses: astral-sh/setup-uv@v4
|
|
19
|
+
|
|
20
|
+
- name: Set up Python
|
|
21
|
+
run: uv python install 3.13
|
|
22
|
+
|
|
23
|
+
- name: Set Python version
|
|
24
|
+
run: uv venv --python 3.13
|
|
25
|
+
|
|
26
|
+
- name: Set up environment
|
|
27
|
+
run: uv sync --all-extras --all-groups
|
|
28
|
+
|
|
29
|
+
- name: Run tests
|
|
30
|
+
run: uv run pytest -m "not extensive" --disable-warnings tests/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
3.13
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
{
|
|
2
|
+
"[python]": {
|
|
3
|
+
"editor.rulers": [
|
|
4
|
+
88
|
|
5
|
+
]
|
|
6
|
+
},
|
|
7
|
+
"[toml]": {
|
|
8
|
+
"editor.defaultFormatter": "tamasfe.even-better-toml"
|
|
9
|
+
},
|
|
10
|
+
"evenBetterToml.formatter.alignComments": true,
|
|
11
|
+
"evenBetterToml.formatter.alignEntries": true,
|
|
12
|
+
"evenBetterToml.formatter.allowedBlankLines": 2,
|
|
13
|
+
"evenBetterToml.formatter.columnWidth": 79,
|
|
14
|
+
"evenBetterToml.formatter.crlf": false,
|
|
15
|
+
"evenBetterToml.formatter.indentTables": false,
|
|
16
|
+
"evenBetterToml.formatter.indentEntries": false,
|
|
17
|
+
"evenBetterToml.formatter.reorderInlineTables": true,
|
|
18
|
+
"evenBetterToml.formatter.trailingNewline": true,
|
|
19
|
+
"evenBetterToml.formatter.arrayAutoCollapse": false,
|
|
20
|
+
"evenBetterToml.formatter.arrayAutoExpand": true,
|
|
21
|
+
"evenBetterToml.formatter.arrayTrailingComma": true,
|
|
22
|
+
"evenBetterToml.formatter.reorderKeys": true,
|
|
23
|
+
"files.exclude": {
|
|
24
|
+
"**/__pycache__": true,
|
|
25
|
+
"**/_minted-main": true,
|
|
26
|
+
"**/*.aux": true,
|
|
27
|
+
"**/*.bbl": true,
|
|
28
|
+
"**/*.bcf": true,
|
|
29
|
+
"**/*.blg": true,
|
|
30
|
+
"**/*.dvi": true,
|
|
31
|
+
"**/*.egg-info": true,
|
|
32
|
+
"**/*.fdb_latexmk": true,
|
|
33
|
+
"**/*.fls": true,
|
|
34
|
+
"**/*.glsdefs": true,
|
|
35
|
+
"**/*.lof": true,
|
|
36
|
+
"**/*.log": true,
|
|
37
|
+
"**/*.lot": true,
|
|
38
|
+
"**/*.mypy_cache": true,
|
|
39
|
+
"**/*.out": true,
|
|
40
|
+
"**/*.pixi": true,
|
|
41
|
+
"**/*.pytest_cache": true,
|
|
42
|
+
"**/*.ruff_cache": true,
|
|
43
|
+
"**/*.run.xml": true,
|
|
44
|
+
"**/*.synctex.gz": true,
|
|
45
|
+
"**/*.toc": true,
|
|
46
|
+
// envs
|
|
47
|
+
"**/*.venv": true,
|
|
48
|
+
"**/*dist": true,
|
|
49
|
+
"**/*synctex(busy)": true
|
|
50
|
+
},
|
|
51
|
+
"notebook.output.textLineLimit": 50,
|
|
52
|
+
"python.defaultInterpreterPath": "${workspaceFolder}/.venv/bin/python",
|
|
53
|
+
"python.terminal.activateEnvironment": false,
|
|
54
|
+
"ruff.interpreter": [
|
|
55
|
+
"${workspaceFolder}/.venv/bin/python"
|
|
56
|
+
],
|
|
57
|
+
"terminal.integrated.env.linux": {
|
|
58
|
+
"UV_PROJECT_ENVIRONMENT": "${workspaceFolder}/.venv"
|
|
59
|
+
},
|
|
60
|
+
"terminal.integrated.env.osx": {
|
|
61
|
+
"UV_PROJECT_ENVIRONMENT": "${workspaceFolder}/.venv"
|
|
62
|
+
}
|
|
63
|
+
}
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
All contributions, bug reports, bug fixes, documentation improvements, enhancements and ideas are welcome.
|
|
2
|
+
In order to contribute:
|
|
3
|
+
|
|
4
|
+
1. [Fork the project](https://github.com/Computational-Biology-Aachen/mxlpy)
|
|
5
|
+
2. Improve or extend the project
|
|
6
|
+
3. Create unit tests for your added / improved features in the respective [test directory](https://github.com/Computational-Biology-Aachen/mxlpy/tree/main/tests). The old test suite mostly uses the standard [unittest](https://docs.python.org/3/library/unittest.html) library, however new tests are written with [pytest](https://docs.pytest.org/en/latest/). If you are not familiar with pytest you can still use the unittest interface, as pytest supports both test styles.
|
|
7
|
+
4. Create a [pull request](https://docs.github.com/de/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request)
|
|
8
|
+
|
|
9
|
+
Your work will then be reviewed as soon as possible (suggestions about some changes, improvements or alternatives may be given).
|
|
10
|
+
|
|
11
|
+
## Coding standards
|
|
12
|
+
|
|
13
|
+
In order for your improvements to be accepted, please make sure that you added tests in the respective subfolder of the [test directory](https://github.com/Computational-Biology-Aachen/mxlpy/tree/main/tests).
|
|
14
|
+
We also ask you to write proper documentation in the [NumPy / SciPy style](https://docs.scipy.org/doc/numpy/docs/howto_document.html) and
|
|
15
|
+
that you name your functions according to [pep8](http://pep8.org/). Further, please use the supplied [pre-commit](https://pre-commit.com/) hook, to make sure that your code passes our guidelines.
|
|
16
|
+
|
|
17
|
+
Thank you for participating!
|
mxlmodels-1.0.0/LICENSE
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) [2025] [Marvin van Aalst, Anna Matuszyńska]
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
mxlmodels-1.0.0/PKG-INFO
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: mxlmodels
|
|
3
|
+
Version: 1.0.0
|
|
4
|
+
Summary: MxlModels is a Python package of reference mechanistic models.
|
|
5
|
+
Author-email: Marvin van Aalst <marvin.vanaalst@gmail.com>
|
|
6
|
+
Maintainer-email: Marvin van Aalst <marvin.vanaalst@gmail.com>
|
|
7
|
+
License-Expression: MIT
|
|
8
|
+
License-File: LICENSE
|
|
9
|
+
Keywords: metabolic,modelling,ode
|
|
10
|
+
Classifier: Development Status :: 5 - Production/Stable
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
15
|
+
Classifier: Operating System :: MacOS
|
|
16
|
+
Classifier: Operating System :: Microsoft :: Windows
|
|
17
|
+
Classifier: Operating System :: OS Independent
|
|
18
|
+
Classifier: Operating System :: POSIX
|
|
19
|
+
Classifier: Operating System :: Unix
|
|
20
|
+
Classifier: Programming Language :: Python :: 3
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
22
|
+
Classifier: Topic :: Scientific/Engineering
|
|
23
|
+
Classifier: Topic :: Software Development
|
|
24
|
+
Requires-Python: >=3.13
|
|
25
|
+
Requires-Dist: mxlpy>=0.38.0
|
|
26
|
+
Description-Content-Type: text/markdown
|
|
27
|
+
|
|
28
|
+
<p align="center">
|
|
29
|
+
<img src="https://raw.githubusercontent.com/Computational-Biology-Aachen/mxl-models/refs/heads/main/docs/assets/logo.png" width="400px" alt='mxlmodels-logo'>
|
|
30
|
+
</p>
|
|
31
|
+
|
|
32
|
+
# MxlModels
|
|
33
|
+
|
|
34
|
+
`MxlModels` is a Python package of reference mechanistic models.
|
|
35
|
+
It contains the same models as in the [MxlBricks](https://github.com/Computational-Biology-Aachen/mxl-bricks) repo, but written as single, flat files to make inspection easier.
|
|
36
|
+
|
|
37
|
+
Usually, these here will be created by codegen from [MxlBricks](https://github.com/Computational-Biology-Aachen/mxl-bricks).
|
|
38
|
+
|
|
39
|
+
## Installation
|
|
40
|
+
|
|
41
|
+
You can install mxlpy using pip: `pip install mxlmodels`.
|
|
42
|
+
|
|
43
|
+
Done. Simple as that.
|
|
44
|
+
|
|
45
|
+
## Models
|
|
46
|
+
|
|
47
|
+
| Name | Description |
|
|
48
|
+
| -------------------- | --------------------------------------------------------------------------- |
|
|
49
|
+
| Yokota 1985 | Photorespiration |
|
|
50
|
+
| Poolman 2000 | CBB cycle, based on Pettersson & Ryde-Pettersson 1988 |
|
|
51
|
+
| Ebenhöh 2011 | PSII & two-state quencher & ATP synthase |
|
|
52
|
+
| Ebenhöh 2014 | PETC & state transitions & ATP synthase from Ebenhoeh 2011 |
|
|
53
|
+
| Matuszyńska 2016 NPQ | 2011 + PSII & four-state quencher |
|
|
54
|
+
| Matuszyńska 2016 PhD | ? |
|
|
55
|
+
| Matuszyńska 2019 | Merges PETC (Ebenhöh 2014), NPQ (Matuszynska 2016) and CBB (Poolman 2000) |
|
|
56
|
+
| Saadat 2021 | 2019 + Mehler (Valero ?) & Thioredoxin & extendend PSI states & consumption |
|
|
57
|
+
| Ebeling 2026 | unpublishd |
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
## Tool family 🏠
|
|
61
|
+
|
|
62
|
+
`MxlModels` is part of a larger family of tools that are designed with a similar set of abstractions. Check them out!
|
|
63
|
+
|
|
64
|
+
- [MxlPy](https://github.com/Computational-Biology-Aachen/MxlPy) is a Python package for mechanistic learning (Mxl)
|
|
65
|
+
- [MxlBricks](https://github.com/Computational-Biology-Aachen/mxl-bricks) is a Python package to build mechanistic models composed of pre-defined reactions (bricks)
|
|
66
|
+
- [MxlWeb](https://github.com/Computational-Biology-Aachen/mxl-web) brings simulation of mechanistic models to the browser!
|
|
67
|
+
- [pysbml](https://github.com/Computational-Biology-Aachen/pysbml) simplifies SBML models for import/export with MxlPy
|
|
68
|
+
- [Parameteriser](https://gitlab.com/marvin.vanaalst/parameteriser) looks up kinetic parameters from BRENDA and other databases
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
<p align="center">
|
|
2
|
+
<img src="https://raw.githubusercontent.com/Computational-Biology-Aachen/mxl-models/refs/heads/main/docs/assets/logo.png" width="400px" alt='mxlmodels-logo'>
|
|
3
|
+
</p>
|
|
4
|
+
|
|
5
|
+
# MxlModels
|
|
6
|
+
|
|
7
|
+
`MxlModels` is a Python package of reference mechanistic models.
|
|
8
|
+
It contains the same models as in the [MxlBricks](https://github.com/Computational-Biology-Aachen/mxl-bricks) repo, but written as single, flat files to make inspection easier.
|
|
9
|
+
|
|
10
|
+
Usually, these here will be created by codegen from [MxlBricks](https://github.com/Computational-Biology-Aachen/mxl-bricks).
|
|
11
|
+
|
|
12
|
+
## Installation
|
|
13
|
+
|
|
14
|
+
You can install mxlpy using pip: `pip install mxlmodels`.
|
|
15
|
+
|
|
16
|
+
Done. Simple as that.
|
|
17
|
+
|
|
18
|
+
## Models
|
|
19
|
+
|
|
20
|
+
| Name | Description |
|
|
21
|
+
| -------------------- | --------------------------------------------------------------------------- |
|
|
22
|
+
| Yokota 1985 | Photorespiration |
|
|
23
|
+
| Poolman 2000 | CBB cycle, based on Pettersson & Ryde-Pettersson 1988 |
|
|
24
|
+
| Ebenhöh 2011 | PSII & two-state quencher & ATP synthase |
|
|
25
|
+
| Ebenhöh 2014 | PETC & state transitions & ATP synthase from Ebenhoeh 2011 |
|
|
26
|
+
| Matuszyńska 2016 NPQ | 2011 + PSII & four-state quencher |
|
|
27
|
+
| Matuszyńska 2016 PhD | ? |
|
|
28
|
+
| Matuszyńska 2019 | Merges PETC (Ebenhöh 2014), NPQ (Matuszynska 2016) and CBB (Poolman 2000) |
|
|
29
|
+
| Saadat 2021 | 2019 + Mehler (Valero ?) & Thioredoxin & extendend PSI states & consumption |
|
|
30
|
+
| Ebeling 2026 | unpublishd |
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
## Tool family 🏠
|
|
34
|
+
|
|
35
|
+
`MxlModels` is part of a larger family of tools that are designed with a similar set of abstractions. Check them out!
|
|
36
|
+
|
|
37
|
+
- [MxlPy](https://github.com/Computational-Biology-Aachen/MxlPy) is a Python package for mechanistic learning (Mxl)
|
|
38
|
+
- [MxlBricks](https://github.com/Computational-Biology-Aachen/mxl-bricks) is a Python package to build mechanistic models composed of pre-defined reactions (bricks)
|
|
39
|
+
- [MxlWeb](https://github.com/Computational-Biology-Aachen/mxl-web) brings simulation of mechanistic models to the browser!
|
|
40
|
+
- [pysbml](https://github.com/Computational-Biology-Aachen/pysbml) simplifies SBML models for import/export with MxlPy
|
|
41
|
+
- [Parameteriser](https://gitlab.com/marvin.vanaalst/parameteriser) looks up kinetic parameters from BRENDA and other databases
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# Security Policy
|
|
2
|
+
|
|
3
|
+
## Supported Versions
|
|
4
|
+
|
|
5
|
+
Use this section to tell people about which versions of your project are
|
|
6
|
+
currently being supported with security updates.
|
|
7
|
+
|
|
8
|
+
| Version | Supported |
|
|
9
|
+
| ------- | ------------------ |
|
|
10
|
+
| 5.1.x | :white_check_mark: |
|
|
11
|
+
| 5.0.x | :x: |
|
|
12
|
+
| 4.0.x | :white_check_mark: |
|
|
13
|
+
| < 4.0 | :x: |
|
|
14
|
+
|
|
15
|
+
## Reporting a Vulnerability
|
|
16
|
+
|
|
17
|
+
Use this section to tell people how to report a vulnerability.
|
|
18
|
+
|
|
19
|
+
Tell them where to go, how often they can expect to get an update on a
|
|
20
|
+
reported vulnerability, what to expect if the vulnerability is accepted or
|
|
21
|
+
declined, etc.
|
|
Binary file
|
|
@@ -0,0 +1,140 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
build-backend = "hatchling.build"
|
|
3
|
+
requires = ["hatchling"]
|
|
4
|
+
|
|
5
|
+
[dependency-groups]
|
|
6
|
+
dev = [
|
|
7
|
+
"coverage>=7.6.4",
|
|
8
|
+
"jupyter>=1.1.1",
|
|
9
|
+
"mike>=2.1.3",
|
|
10
|
+
"mkdocs-jupyter>=0.25.1",
|
|
11
|
+
"mkdocs-material>=9.5.42",
|
|
12
|
+
"mkdocs>=1.6.1,<2.0.0",
|
|
13
|
+
"pre-commit>=4.0.1",
|
|
14
|
+
"pyright>=1.1.403",
|
|
15
|
+
"pytest-cov>=5.0.0",
|
|
16
|
+
"pytest>=8.3.3",
|
|
17
|
+
"ruff>=0.15.11",
|
|
18
|
+
]
|
|
19
|
+
|
|
20
|
+
[project]
|
|
21
|
+
authors = [{ email = "marvin.vanaalst@gmail.com", name = "Marvin van Aalst" }]
|
|
22
|
+
classifiers = [
|
|
23
|
+
"Development Status :: 5 - Production/Stable",
|
|
24
|
+
"Environment :: Console",
|
|
25
|
+
"Intended Audience :: Developers",
|
|
26
|
+
"Intended Audience :: Science/Research",
|
|
27
|
+
"License :: OSI Approved :: MIT License",
|
|
28
|
+
"Operating System :: MacOS",
|
|
29
|
+
"Operating System :: Microsoft :: Windows",
|
|
30
|
+
"Operating System :: OS Independent",
|
|
31
|
+
"Operating System :: POSIX",
|
|
32
|
+
"Operating System :: Unix",
|
|
33
|
+
"Programming Language :: Python :: 3",
|
|
34
|
+
"Programming Language :: Python :: 3.11",
|
|
35
|
+
"Topic :: Scientific/Engineering",
|
|
36
|
+
"Topic :: Software Development",
|
|
37
|
+
]
|
|
38
|
+
dependencies = ["mxlpy>=0.38.0"]
|
|
39
|
+
description = "MxlModels is a Python package of reference mechanistic models."
|
|
40
|
+
keywords = ["metabolic", "modelling", "ode"]
|
|
41
|
+
license = "MIT"
|
|
42
|
+
maintainers = [
|
|
43
|
+
{ email = "marvin.vanaalst@gmail.com", name = "Marvin van Aalst" },
|
|
44
|
+
]
|
|
45
|
+
name = "mxlmodels"
|
|
46
|
+
readme = "README.md"
|
|
47
|
+
requires-python = ">=3.13"
|
|
48
|
+
version = "1.0.0"
|
|
49
|
+
|
|
50
|
+
[tool.hatchling]
|
|
51
|
+
from = "src"
|
|
52
|
+
include = ["mxlmodels"]
|
|
53
|
+
|
|
54
|
+
[tool.pyright]
|
|
55
|
+
deprecateTypingAliases = true
|
|
56
|
+
exclude = [
|
|
57
|
+
"**/.*",
|
|
58
|
+
"**/__pycache__",
|
|
59
|
+
"**/node_modules",
|
|
60
|
+
".venv",
|
|
61
|
+
"tests/sbml/assets",
|
|
62
|
+
"tmp",
|
|
63
|
+
]
|
|
64
|
+
include = ["docs", "src", "tests", 'publication-figures']
|
|
65
|
+
pythonVersion = "3.13"
|
|
66
|
+
reportMissingModuleSource = "none"
|
|
67
|
+
strict = []
|
|
68
|
+
|
|
69
|
+
[tool.ruff]
|
|
70
|
+
indent-width = 4
|
|
71
|
+
line-length = 88
|
|
72
|
+
|
|
73
|
+
[tool.ruff.lint]
|
|
74
|
+
fixable = ["ALL"]
|
|
75
|
+
ignore = [
|
|
76
|
+
"ANN401", # any
|
|
77
|
+
"C901", # too complex
|
|
78
|
+
"COM812", # missing trailing comma # "D", # all of documentation
|
|
79
|
+
"D105", # magic methods
|
|
80
|
+
"D203", # blank line before docstring
|
|
81
|
+
"D213", # multi-line summary first line
|
|
82
|
+
"D401", # first line should be in imperative mood
|
|
83
|
+
"E501", # line-too-long
|
|
84
|
+
"ERA001", # commented-out code
|
|
85
|
+
"FIX001", # line contains FIXME
|
|
86
|
+
"ISC001", # single line implicit string concat
|
|
87
|
+
"N806", # non-lowercase variable
|
|
88
|
+
"N818", # Exception should end in "Error"
|
|
89
|
+
"PD010", # pivot table
|
|
90
|
+
"PGH003", # specific rule type ignore
|
|
91
|
+
"PLR0911", # too many statements
|
|
92
|
+
"PLR0912", # too many branches
|
|
93
|
+
"PLR0913", # max num of arguments
|
|
94
|
+
"PLR0915", # too many lines
|
|
95
|
+
"PT011", # pytest.raises is too broad
|
|
96
|
+
"RUF022", # unsorted all
|
|
97
|
+
"S110", # try-except-pass
|
|
98
|
+
"S301", # pickle usage
|
|
99
|
+
"TC006", # cast("type")
|
|
100
|
+
"TD001", # invalid todo tag
|
|
101
|
+
"TD002", # missing todo author
|
|
102
|
+
"TD003", # missing todo link
|
|
103
|
+
"TD004", # missing todo version
|
|
104
|
+
"TD005", # missing todo date
|
|
105
|
+
"TRY003", # raise vanilla args
|
|
106
|
+
]
|
|
107
|
+
select = ["ALL"]
|
|
108
|
+
|
|
109
|
+
[tool.ruff.lint.per-file-ignores]
|
|
110
|
+
"*.ipynb" = [
|
|
111
|
+
"D", # all of documentation
|
|
112
|
+
"T201", # print statements
|
|
113
|
+
]
|
|
114
|
+
"tests/*" = [
|
|
115
|
+
"D", # all of documentation
|
|
116
|
+
"PD901", # "df" name
|
|
117
|
+
"PLR2004", # magic comparisons
|
|
118
|
+
"S101", # assert
|
|
119
|
+
"SLF",
|
|
120
|
+
]
|
|
121
|
+
"tmp/*" = [
|
|
122
|
+
"D", # all of documentation
|
|
123
|
+
"I001", # unsorted imports
|
|
124
|
+
"N", # all of naming
|
|
125
|
+
"S101", # assert
|
|
126
|
+
]
|
|
127
|
+
|
|
128
|
+
[tool.ruff.lint.pydocstyle]
|
|
129
|
+
convention = "numpy"
|
|
130
|
+
|
|
131
|
+
[tool.tomlsort]
|
|
132
|
+
spaces_before_inline_comment = 2
|
|
133
|
+
spaces_indent_inline_array = 2
|
|
134
|
+
trailing_comma_inline_array = true
|
|
135
|
+
|
|
136
|
+
[tool.uv]
|
|
137
|
+
package = true
|
|
138
|
+
|
|
139
|
+
[tool.uv.sources]
|
|
140
|
+
mxlmodels = { workspace = true }
|