POMtool 100.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.
@@ -0,0 +1,7 @@
1
+ Copyright 2025 Ossi Noita
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
+
5
+ The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6
+
7
+ THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,83 @@
1
+ Metadata-Version: 2.4
2
+ Name: POMtool
3
+ Version: 100.0.0
4
+ Summary: Scientific command line tool
5
+ License: MIT
6
+ Requires-Python: ==3.11.*
7
+ Description-Content-Type: text/markdown
8
+ License-File: LICENSE.md
9
+ Requires-Dist: numpy==2.3.2
10
+ Requires-Dist: PyYAML==6.0.2
11
+ Requires-Dist: scimath==5.0.0
12
+ Requires-Dist: scipy==1.16.1
13
+ Requires-Dist: traits==7.0.2
14
+ Dynamic: license-file
15
+
16
+ # POM tool
17
+
18
+ ## Description
19
+ This is commpand line interface (CLI) tool to create population of model and calibrate your model. It can calculate biomarkers, and calibrate either your model or your population based on those parameters.
20
+
21
+ ## Installation
22
+ There are few options how to start using POMtool.
23
+
24
+ ### pipx
25
+ Using pipx you can download package and install it as command line interface. In addition, it is recommended to set your version
26
+ ```
27
+ pipx install "POMtool~=100.0"
28
+ ```
29
+ However, typically you do not have correct python version. as your default.
30
+
31
+ POMtool version 100.0 requires python 3.11, so using python, so you would need to use
32
+ ```
33
+ pipx install --python <path/to/correct/python> "POMtool~=100.0"
34
+ ```
35
+
36
+ For example, if you have python3.11 installed, you can use
37
+ ```
38
+ pipx install --python python3.11 "POMtool~=100.0"
39
+ ```
40
+ For pyenv installation, point to correct shim
41
+ ```
42
+ pipx install --python ~/.pyenv/versions/3.11.11/bin/python "POMtool~=100.0"
43
+ ```
44
+
45
+ ### Clone
46
+ Clone the repository and run inside the repository:
47
+ ```
48
+ ./POMtool.py run --help
49
+ ```
50
+
51
+ To follow other examples, create alias for `POMtool`, or keep using `./POMtool.py` directly. For example with:
52
+ ```
53
+ ./POMtool.py run --help && alias POMtool="python $(pwd)/POMtool.py"
54
+ ```
55
+
56
+ ### pip
57
+ Using pip is also possible. Just create virtual environment with correct python version. For most use cases, you should use `pipx` instead.
58
+
59
+ ## Using
60
+ Use -h to get help-file for the CLI. Currently, this is only tested on python, newer python version might not work.
61
+
62
+ Every config should describe model. This section describes how model you are interested can be run and how to input parameters to it.
63
+
64
+ You have two options what to do with model, you can run POM-experiment (experiment), or model optimization (optimization).
65
+
66
+ In POM-experiment first model is run for each set of parameters as described in `experiment`. After that `biomarkers` are calculated. With biomarkers, we can calibrate our population based on protocols described in `calibration`.
67
+
68
+ In optimization, parameters are changed with goal to match biomarkers given as arguments. Biomarkers are calculated as given in `biomarkers` and `optimization` describes optimization process.
69
+
70
+ To create your own config, check examples directory. All examples there are runnable (at moment of writing, only one example).
71
+
72
+ ## Future
73
+ * More ways to use the tool will be made available as the project progresses
74
+ * Improvements to this document are added, as issues arise
75
+ * More examples will be provided, and some example projects will be made public for best practices
76
+ * Some thoughts can also be found from roadmap
77
+
78
+ ## Acknowledgements
79
+ Initial production of this tool was partly funded by [SMASH-HCM](https://smash-hcm.eu/), which is funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Education and Culture Executive Agency (EACEA). Neither the European Union nor EACEA can be held responsible for them.
80
+
81
+ ## Authors
82
+ Ossi Noita - Original concept and current maintainer
83
+ Olli Ylinen - Major contributions to optimization, biomarkers, and testing
@@ -0,0 +1,68 @@
1
+ # POM tool
2
+
3
+ ## Description
4
+ This is commpand line interface (CLI) tool to create population of model and calibrate your model. It can calculate biomarkers, and calibrate either your model or your population based on those parameters.
5
+
6
+ ## Installation
7
+ There are few options how to start using POMtool.
8
+
9
+ ### pipx
10
+ Using pipx you can download package and install it as command line interface. In addition, it is recommended to set your version
11
+ ```
12
+ pipx install "POMtool~=100.0"
13
+ ```
14
+ However, typically you do not have correct python version. as your default.
15
+
16
+ POMtool version 100.0 requires python 3.11, so using python, so you would need to use
17
+ ```
18
+ pipx install --python <path/to/correct/python> "POMtool~=100.0"
19
+ ```
20
+
21
+ For example, if you have python3.11 installed, you can use
22
+ ```
23
+ pipx install --python python3.11 "POMtool~=100.0"
24
+ ```
25
+ For pyenv installation, point to correct shim
26
+ ```
27
+ pipx install --python ~/.pyenv/versions/3.11.11/bin/python "POMtool~=100.0"
28
+ ```
29
+
30
+ ### Clone
31
+ Clone the repository and run inside the repository:
32
+ ```
33
+ ./POMtool.py run --help
34
+ ```
35
+
36
+ To follow other examples, create alias for `POMtool`, or keep using `./POMtool.py` directly. For example with:
37
+ ```
38
+ ./POMtool.py run --help && alias POMtool="python $(pwd)/POMtool.py"
39
+ ```
40
+
41
+ ### pip
42
+ Using pip is also possible. Just create virtual environment with correct python version. For most use cases, you should use `pipx` instead.
43
+
44
+ ## Using
45
+ Use -h to get help-file for the CLI. Currently, this is only tested on python, newer python version might not work.
46
+
47
+ Every config should describe model. This section describes how model you are interested can be run and how to input parameters to it.
48
+
49
+ You have two options what to do with model, you can run POM-experiment (experiment), or model optimization (optimization).
50
+
51
+ In POM-experiment first model is run for each set of parameters as described in `experiment`. After that `biomarkers` are calculated. With biomarkers, we can calibrate our population based on protocols described in `calibration`.
52
+
53
+ In optimization, parameters are changed with goal to match biomarkers given as arguments. Biomarkers are calculated as given in `biomarkers` and `optimization` describes optimization process.
54
+
55
+ To create your own config, check examples directory. All examples there are runnable (at moment of writing, only one example).
56
+
57
+ ## Future
58
+ * More ways to use the tool will be made available as the project progresses
59
+ * Improvements to this document are added, as issues arise
60
+ * More examples will be provided, and some example projects will be made public for best practices
61
+ * Some thoughts can also be found from roadmap
62
+
63
+ ## Acknowledgements
64
+ Initial production of this tool was partly funded by [SMASH-HCM](https://smash-hcm.eu/), which is funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Education and Culture Executive Agency (EACEA). Neither the European Union nor EACEA can be held responsible for them.
65
+
66
+ ## Authors
67
+ Ossi Noita - Original concept and current maintainer
68
+ Olli Ylinen - Major contributions to optimization, biomarkers, and testing
@@ -0,0 +1,29 @@
1
+ [build-system]
2
+ requires = ["setuptools>=68", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "POMtool"
7
+ version = "100.0.0"
8
+ description = "Scientific command line tool"
9
+ readme = "README.md"
10
+ license = { text = "MIT" }
11
+
12
+ requires-python = "==3.11.*"
13
+
14
+ dependencies = [
15
+ "numpy==2.3.2",
16
+ "PyYAML==6.0.2",
17
+ "scimath==5.0.0",
18
+ "scipy==1.16.1",
19
+ "traits==7.0.2",
20
+ ]
21
+
22
+ [project.scripts]
23
+ POMtool = "pomtool.main:run"
24
+
25
+ [tool.setuptools]
26
+ package-dir = {"" = "src"}
27
+
28
+ [tool.setuptools.packages.find]
29
+ where = ["src"]
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,83 @@
1
+ Metadata-Version: 2.4
2
+ Name: POMtool
3
+ Version: 100.0.0
4
+ Summary: Scientific command line tool
5
+ License: MIT
6
+ Requires-Python: ==3.11.*
7
+ Description-Content-Type: text/markdown
8
+ License-File: LICENSE.md
9
+ Requires-Dist: numpy==2.3.2
10
+ Requires-Dist: PyYAML==6.0.2
11
+ Requires-Dist: scimath==5.0.0
12
+ Requires-Dist: scipy==1.16.1
13
+ Requires-Dist: traits==7.0.2
14
+ Dynamic: license-file
15
+
16
+ # POM tool
17
+
18
+ ## Description
19
+ This is commpand line interface (CLI) tool to create population of model and calibrate your model. It can calculate biomarkers, and calibrate either your model or your population based on those parameters.
20
+
21
+ ## Installation
22
+ There are few options how to start using POMtool.
23
+
24
+ ### pipx
25
+ Using pipx you can download package and install it as command line interface. In addition, it is recommended to set your version
26
+ ```
27
+ pipx install "POMtool~=100.0"
28
+ ```
29
+ However, typically you do not have correct python version. as your default.
30
+
31
+ POMtool version 100.0 requires python 3.11, so using python, so you would need to use
32
+ ```
33
+ pipx install --python <path/to/correct/python> "POMtool~=100.0"
34
+ ```
35
+
36
+ For example, if you have python3.11 installed, you can use
37
+ ```
38
+ pipx install --python python3.11 "POMtool~=100.0"
39
+ ```
40
+ For pyenv installation, point to correct shim
41
+ ```
42
+ pipx install --python ~/.pyenv/versions/3.11.11/bin/python "POMtool~=100.0"
43
+ ```
44
+
45
+ ### Clone
46
+ Clone the repository and run inside the repository:
47
+ ```
48
+ ./POMtool.py run --help
49
+ ```
50
+
51
+ To follow other examples, create alias for `POMtool`, or keep using `./POMtool.py` directly. For example with:
52
+ ```
53
+ ./POMtool.py run --help && alias POMtool="python $(pwd)/POMtool.py"
54
+ ```
55
+
56
+ ### pip
57
+ Using pip is also possible. Just create virtual environment with correct python version. For most use cases, you should use `pipx` instead.
58
+
59
+ ## Using
60
+ Use -h to get help-file for the CLI. Currently, this is only tested on python, newer python version might not work.
61
+
62
+ Every config should describe model. This section describes how model you are interested can be run and how to input parameters to it.
63
+
64
+ You have two options what to do with model, you can run POM-experiment (experiment), or model optimization (optimization).
65
+
66
+ In POM-experiment first model is run for each set of parameters as described in `experiment`. After that `biomarkers` are calculated. With biomarkers, we can calibrate our population based on protocols described in `calibration`.
67
+
68
+ In optimization, parameters are changed with goal to match biomarkers given as arguments. Biomarkers are calculated as given in `biomarkers` and `optimization` describes optimization process.
69
+
70
+ To create your own config, check examples directory. All examples there are runnable (at moment of writing, only one example).
71
+
72
+ ## Future
73
+ * More ways to use the tool will be made available as the project progresses
74
+ * Improvements to this document are added, as issues arise
75
+ * More examples will be provided, and some example projects will be made public for best practices
76
+ * Some thoughts can also be found from roadmap
77
+
78
+ ## Acknowledgements
79
+ Initial production of this tool was partly funded by [SMASH-HCM](https://smash-hcm.eu/), which is funded by the European Union. Views and opinions expressed are however those of the author(s) only and do not necessarily reflect those of the European Union or the European Education and Culture Executive Agency (EACEA). Neither the European Union nor EACEA can be held responsible for them.
80
+
81
+ ## Authors
82
+ Ossi Noita - Original concept and current maintainer
83
+ Olli Ylinen - Major contributions to optimization, biomarkers, and testing
@@ -0,0 +1,20 @@
1
+ LICENSE.md
2
+ README.md
3
+ pyproject.toml
4
+ src/POMtool.egg-info/PKG-INFO
5
+ src/POMtool.egg-info/SOURCES.txt
6
+ src/POMtool.egg-info/dependency_links.txt
7
+ src/POMtool.egg-info/entry_points.txt
8
+ src/POMtool.egg-info/requires.txt
9
+ src/POMtool.egg-info/top_level.txt
10
+ src/pomtool/__init__.py
11
+ src/pomtool/biomarker.py
12
+ src/pomtool/calibration.py
13
+ src/pomtool/experiment.py
14
+ src/pomtool/log.py
15
+ src/pomtool/loss_function.py
16
+ src/pomtool/main.py
17
+ src/pomtool/merge.py
18
+ src/pomtool/model.py
19
+ src/pomtool/optimization.py
20
+ src/pomtool/utility.py
@@ -0,0 +1,2 @@
1
+ [console_scripts]
2
+ POMtool = pomtool.main:run
@@ -0,0 +1,5 @@
1
+ numpy==2.3.2
2
+ PyYAML==6.0.2
3
+ scimath==5.0.0
4
+ scipy==1.16.1
5
+ traits==7.0.2
@@ -0,0 +1 @@
1
+ pomtool
File without changes