nomogram 0.1.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.
- nomogram-0.1.0/LICENSE +28 -0
- nomogram-0.1.0/PKG-INFO +125 -0
- nomogram-0.1.0/README.md +91 -0
- nomogram-0.1.0/pyproject.toml +154 -0
- nomogram-0.1.0/pyproject.toml.orig +130 -0
- nomogram-0.1.0/src/nomogram/__init__.py +17 -0
- nomogram-0.1.0/src/nomogram/catalog.py +533 -0
- nomogram-0.1.0/src/nomogram/comparison.py +305 -0
- nomogram-0.1.0/src/nomogram/data/NOTICE.md +25 -0
- nomogram-0.1.0/src/nomogram/data/catalog/humidity.toml +534 -0
- nomogram-0.1.0/src/nomogram/data/semantics.json +464 -0
- nomogram-0.1.0/src/nomogram/expression.py +232 -0
- nomogram-0.1.0/src/nomogram/model.py +594 -0
- nomogram-0.1.0/src/nomogram/plot.py +176 -0
- nomogram-0.1.0/src/nomogram/py.typed +0 -0
- nomogram-0.1.0/src/nomogram/semantics.py +333 -0
- nomogram-0.1.0/src/nomogram/units.py +118 -0
nomogram-0.1.0/LICENSE
ADDED
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
BSD 3-Clause License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026, Miki
|
|
4
|
+
|
|
5
|
+
Redistribution and use in source and binary forms, with or without
|
|
6
|
+
modification, are permitted provided that the following conditions are met:
|
|
7
|
+
|
|
8
|
+
1. Redistributions of source code must retain the above copyright notice, this
|
|
9
|
+
list of conditions and the following disclaimer.
|
|
10
|
+
|
|
11
|
+
2. Redistributions in binary form must reproduce the above copyright notice,
|
|
12
|
+
this list of conditions and the following disclaimer in the documentation
|
|
13
|
+
and/or other materials provided with the distribution.
|
|
14
|
+
|
|
15
|
+
3. Neither the name of the copyright holder nor the names of its
|
|
16
|
+
contributors may be used to endorse or promote products derived from
|
|
17
|
+
this software without specific prior written permission.
|
|
18
|
+
|
|
19
|
+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
|
|
20
|
+
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
|
|
21
|
+
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
|
|
22
|
+
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
|
|
23
|
+
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
|
|
24
|
+
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
|
|
25
|
+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
|
|
26
|
+
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
|
|
27
|
+
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
|
28
|
+
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
nomogram-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: nomogram
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Repository of scientific formulas: notations, units, validity domains
|
|
5
|
+
Keywords: scientific computing,formulas,units,dimensional analysis,physics,thermodynamics,geoscience,atmospheric science,meteorology,hydrology,psychrometrics
|
|
6
|
+
Author: miki4ia
|
|
7
|
+
Author-email: miki4ia <miki4ia@gmail.com>
|
|
8
|
+
License-Expression: BSD-3-Clause AND CC-BY-4.0 AND CC0-1.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
License-File: src/nomogram/data/NOTICE.md
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Topic :: Scientific/Engineering
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
|
|
20
|
+
Classifier: Topic :: Scientific/Engineering :: Hydrology
|
|
21
|
+
Classifier: Topic :: Scientific/Engineering :: Physics
|
|
22
|
+
Classifier: Typing :: Typed
|
|
23
|
+
Requires-Dist: numpy>=2.0
|
|
24
|
+
Requires-Dist: pint>=0.24.4
|
|
25
|
+
Requires-Dist: sympy>=1.13
|
|
26
|
+
Requires-Dist: matplotlib>=3.10.7 ; extra == 'viz'
|
|
27
|
+
Requires-Python: >=3.12
|
|
28
|
+
Project-URL: Homepage, https://github.com/miki4iaml/nomogram
|
|
29
|
+
Project-URL: Repository, https://github.com/miki4iaml/nomogram
|
|
30
|
+
Project-URL: Issues, https://github.com/miki4iaml/nomogram/issues
|
|
31
|
+
Project-URL: Changelog, https://github.com/miki4iaml/nomogram/blob/main/CHANGELOG.md
|
|
32
|
+
Provides-Extra: viz
|
|
33
|
+
Description-Content-Type: text/markdown
|
|
34
|
+
|
|
35
|
+
# nomogram
|
|
36
|
+
|
|
37
|
+
**English** | [Français](README.fr.md)
|
|
38
|
+
|
|
39
|
+
[](https://github.com/miki4iaml/nomogram/actions/workflows/ci.yml)
|
|
40
|
+
[](https://github.com/miki4iaml/nomogram/actions/workflows/github-code-scanning/codeql)
|
|
41
|
+
[](https://codecov.io/gh/miki4iaml/nomogram)
|
|
42
|
+
[](pyproject.toml)
|
|
43
|
+
[](LICENSE)
|
|
44
|
+
[](https://github.com/astral-sh/uv)
|
|
45
|
+
[](https://github.com/astral-sh/ruff)
|
|
46
|
+
[](https://mypy-lang.org/)
|
|
47
|
+
[](https://www.conventionalcommits.org/en/v1.0.0/)
|
|
48
|
+
|
|
49
|
+
A repository of scientific formulas: alternative notations across
|
|
50
|
+
authors and conventions, parameter units (including empirical ones),
|
|
51
|
+
validity domains, LaTeX rendering and symbolic computation.
|
|
52
|
+
|
|
53
|
+
Pure Python, built on SymPy, numpy and pint; it works on an offline
|
|
54
|
+
workstation (no online engine).
|
|
55
|
+
|
|
56
|
+
> Early stage project (alpha).
|
|
57
|
+
|
|
58
|
+
## Installation
|
|
59
|
+
|
|
60
|
+
```
|
|
61
|
+
pip install nomogram # core
|
|
62
|
+
pip install "nomogram[viz]" # with plots (matplotlib)
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
## Installation from source
|
|
66
|
+
|
|
67
|
+
```
|
|
68
|
+
git clone https://github.com/miki4iaml/nomogram.git
|
|
69
|
+
cd nomogram
|
|
70
|
+
uv sync
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
Python 3.12 or later. Plots need the `viz` extra (matplotlib):
|
|
74
|
+
`uv sync --extra viz`.
|
|
75
|
+
|
|
76
|
+
## Example
|
|
77
|
+
|
|
78
|
+
Every saturation vapour pressure formulation of the catalog against the
|
|
79
|
+
IAPWS reference; curves stop where a formulation leaves its stated
|
|
80
|
+
validity domain ([script](docs/examples/saturation_vapour_pressure.py)):
|
|
81
|
+
|
|
82
|
+
```python
|
|
83
|
+
import numpy as np
|
|
84
|
+
from nomogram.catalog import catalog
|
|
85
|
+
from nomogram.comparison import compare
|
|
86
|
+
from nomogram.plot import plot_deviations # extra viz
|
|
87
|
+
from nomogram.units import Q_
|
|
88
|
+
|
|
89
|
+
formulations = catalog().formulations_of("SaturationVapourPressureOverWater")
|
|
90
|
+
reference = catalog().formulations["iapws_sr1_86"]
|
|
91
|
+
temperatures = Q_(np.linspace(-60, 110, 341), "degC")
|
|
92
|
+
|
|
93
|
+
table = compare(formulations, reference, {"ThermodynamicTemperature": temperatures})
|
|
94
|
+
plot_deviations(table)
|
|
95
|
+
```
|
|
96
|
+
|
|
97
|
+
|
|
98
|
+
|
|
99
|
+
## Usage
|
|
100
|
+
|
|
101
|
+
The table holds the values and the relative deviations, by formulation;
|
|
102
|
+
values outside a formulation's validity domain are NaN unless asked
|
|
103
|
+
otherwise (`outside="ignore"`). Formulations also chain, for instance
|
|
104
|
+
the absolute humidity from any saturation vapour pressure formulation:
|
|
105
|
+
|
|
106
|
+
```python
|
|
107
|
+
from nomogram.comparison import compose
|
|
108
|
+
|
|
109
|
+
ha = compose(catalog().formulations["mass_concentration_ideal_gas"], {"e_s": reference})
|
|
110
|
+
ha.evaluate(RH=Q_(100, "percent"), T=Q_(20, "degC")).to("g/m^3") # 17.29
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Each formulation keeps its units, validity domain, temperature scale and
|
|
114
|
+
references. The vocabulary is mapped in [docs/rosetta.md](docs/rosetta.md).
|
|
115
|
+
|
|
116
|
+
## Contributing
|
|
117
|
+
|
|
118
|
+
References to integrate, information or corrections about catalog
|
|
119
|
+
entries, new formulas and code are all welcome: see the
|
|
120
|
+
[ways to contribute](.github/CONTRIBUTING.md#ways-to-contribute) and
|
|
121
|
+
the [catalog guide](docs/catalog.md).
|
|
122
|
+
|
|
123
|
+
## License
|
|
124
|
+
|
|
125
|
+
[BSD-3-Clause](LICENSE).
|
nomogram-0.1.0/README.md
ADDED
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
# nomogram
|
|
2
|
+
|
|
3
|
+
**English** | [Français](README.fr.md)
|
|
4
|
+
|
|
5
|
+
[](https://github.com/miki4iaml/nomogram/actions/workflows/ci.yml)
|
|
6
|
+
[](https://github.com/miki4iaml/nomogram/actions/workflows/github-code-scanning/codeql)
|
|
7
|
+
[](https://codecov.io/gh/miki4iaml/nomogram)
|
|
8
|
+
[](pyproject.toml)
|
|
9
|
+
[](LICENSE)
|
|
10
|
+
[](https://github.com/astral-sh/uv)
|
|
11
|
+
[](https://github.com/astral-sh/ruff)
|
|
12
|
+
[](https://mypy-lang.org/)
|
|
13
|
+
[](https://www.conventionalcommits.org/en/v1.0.0/)
|
|
14
|
+
|
|
15
|
+
A repository of scientific formulas: alternative notations across
|
|
16
|
+
authors and conventions, parameter units (including empirical ones),
|
|
17
|
+
validity domains, LaTeX rendering and symbolic computation.
|
|
18
|
+
|
|
19
|
+
Pure Python, built on SymPy, numpy and pint; it works on an offline
|
|
20
|
+
workstation (no online engine).
|
|
21
|
+
|
|
22
|
+
> Early stage project (alpha).
|
|
23
|
+
|
|
24
|
+
## Installation
|
|
25
|
+
|
|
26
|
+
```
|
|
27
|
+
pip install nomogram # core
|
|
28
|
+
pip install "nomogram[viz]" # with plots (matplotlib)
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
## Installation from source
|
|
32
|
+
|
|
33
|
+
```
|
|
34
|
+
git clone https://github.com/miki4iaml/nomogram.git
|
|
35
|
+
cd nomogram
|
|
36
|
+
uv sync
|
|
37
|
+
```
|
|
38
|
+
|
|
39
|
+
Python 3.12 or later. Plots need the `viz` extra (matplotlib):
|
|
40
|
+
`uv sync --extra viz`.
|
|
41
|
+
|
|
42
|
+
## Example
|
|
43
|
+
|
|
44
|
+
Every saturation vapour pressure formulation of the catalog against the
|
|
45
|
+
IAPWS reference; curves stop where a formulation leaves its stated
|
|
46
|
+
validity domain ([script](docs/examples/saturation_vapour_pressure.py)):
|
|
47
|
+
|
|
48
|
+
```python
|
|
49
|
+
import numpy as np
|
|
50
|
+
from nomogram.catalog import catalog
|
|
51
|
+
from nomogram.comparison import compare
|
|
52
|
+
from nomogram.plot import plot_deviations # extra viz
|
|
53
|
+
from nomogram.units import Q_
|
|
54
|
+
|
|
55
|
+
formulations = catalog().formulations_of("SaturationVapourPressureOverWater")
|
|
56
|
+
reference = catalog().formulations["iapws_sr1_86"]
|
|
57
|
+
temperatures = Q_(np.linspace(-60, 110, 341), "degC")
|
|
58
|
+
|
|
59
|
+
table = compare(formulations, reference, {"ThermodynamicTemperature": temperatures})
|
|
60
|
+
plot_deviations(table)
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
## Usage
|
|
66
|
+
|
|
67
|
+
The table holds the values and the relative deviations, by formulation;
|
|
68
|
+
values outside a formulation's validity domain are NaN unless asked
|
|
69
|
+
otherwise (`outside="ignore"`). Formulations also chain, for instance
|
|
70
|
+
the absolute humidity from any saturation vapour pressure formulation:
|
|
71
|
+
|
|
72
|
+
```python
|
|
73
|
+
from nomogram.comparison import compose
|
|
74
|
+
|
|
75
|
+
ha = compose(catalog().formulations["mass_concentration_ideal_gas"], {"e_s": reference})
|
|
76
|
+
ha.evaluate(RH=Q_(100, "percent"), T=Q_(20, "degC")).to("g/m^3") # 17.29
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Each formulation keeps its units, validity domain, temperature scale and
|
|
80
|
+
references. The vocabulary is mapped in [docs/rosetta.md](docs/rosetta.md).
|
|
81
|
+
|
|
82
|
+
## Contributing
|
|
83
|
+
|
|
84
|
+
References to integrate, information or corrections about catalog
|
|
85
|
+
entries, new formulas and code are all welcome: see the
|
|
86
|
+
[ways to contribute](.github/CONTRIBUTING.md#ways-to-contribute) and
|
|
87
|
+
the [catalog guide](docs/catalog.md).
|
|
88
|
+
|
|
89
|
+
## License
|
|
90
|
+
|
|
91
|
+
[BSD-3-Clause](LICENSE).
|
|
@@ -0,0 +1,154 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "nomogram"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "Repository of scientific formulas: notations, units, validity domains"
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.12"
|
|
7
|
+
license = "BSD-3-Clause AND CC-BY-4.0 AND CC0-1.0"
|
|
8
|
+
license-files = [
|
|
9
|
+
"LICENSE",
|
|
10
|
+
"src/nomogram/data/NOTICE.md",
|
|
11
|
+
]
|
|
12
|
+
keywords = [
|
|
13
|
+
"scientific computing",
|
|
14
|
+
"formulas",
|
|
15
|
+
"units",
|
|
16
|
+
"dimensional analysis",
|
|
17
|
+
"physics",
|
|
18
|
+
"thermodynamics",
|
|
19
|
+
"geoscience",
|
|
20
|
+
"atmospheric science",
|
|
21
|
+
"meteorology",
|
|
22
|
+
"hydrology",
|
|
23
|
+
"psychrometrics",
|
|
24
|
+
]
|
|
25
|
+
classifiers = [
|
|
26
|
+
"Development Status :: 3 - Alpha",
|
|
27
|
+
"Intended Audience :: Science/Research",
|
|
28
|
+
"Operating System :: OS Independent",
|
|
29
|
+
"Programming Language :: Python :: 3",
|
|
30
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
31
|
+
"Programming Language :: Python :: 3.12",
|
|
32
|
+
"Programming Language :: Python :: 3.13",
|
|
33
|
+
"Topic :: Scientific/Engineering",
|
|
34
|
+
"Topic :: Scientific/Engineering :: Atmospheric Science",
|
|
35
|
+
"Topic :: Scientific/Engineering :: Hydrology",
|
|
36
|
+
"Topic :: Scientific/Engineering :: Physics",
|
|
37
|
+
"Typing :: Typed",
|
|
38
|
+
]
|
|
39
|
+
dependencies = [
|
|
40
|
+
"numpy>=2.0",
|
|
41
|
+
"pint>=0.24.4",
|
|
42
|
+
"sympy>=1.13",
|
|
43
|
+
]
|
|
44
|
+
|
|
45
|
+
[[project.authors]]
|
|
46
|
+
name = "miki4ia"
|
|
47
|
+
email = "miki4ia@gmail.com"
|
|
48
|
+
|
|
49
|
+
[project.urls]
|
|
50
|
+
Homepage = "https://github.com/miki4iaml/nomogram"
|
|
51
|
+
Repository = "https://github.com/miki4iaml/nomogram"
|
|
52
|
+
Issues = "https://github.com/miki4iaml/nomogram/issues"
|
|
53
|
+
Changelog = "https://github.com/miki4iaml/nomogram/blob/main/CHANGELOG.md"
|
|
54
|
+
|
|
55
|
+
[project.optional-dependencies]
|
|
56
|
+
viz = ["matplotlib>=3.10.7"]
|
|
57
|
+
|
|
58
|
+
[build-system]
|
|
59
|
+
requires = ["uv_build>=0.12.18,<0.13.0"]
|
|
60
|
+
build-backend = "uv_build"
|
|
61
|
+
|
|
62
|
+
[dependency-groups]
|
|
63
|
+
dev = [
|
|
64
|
+
"codespell>=2.4.3",
|
|
65
|
+
"coverage>=7.16.2",
|
|
66
|
+
"mypy>=2.4.0",
|
|
67
|
+
"pre-commit>=4.6.2",
|
|
68
|
+
"pytest>=9.1.1",
|
|
69
|
+
"rdflib>=7.6",
|
|
70
|
+
"ruff>=0.16.9",
|
|
71
|
+
"zizmor>=1.30.1",
|
|
72
|
+
]
|
|
73
|
+
|
|
74
|
+
[tool.mypy]
|
|
75
|
+
python_version = "3.12"
|
|
76
|
+
strict = true
|
|
77
|
+
files = [
|
|
78
|
+
"src",
|
|
79
|
+
"tests",
|
|
80
|
+
"scripts",
|
|
81
|
+
"docs/examples",
|
|
82
|
+
]
|
|
83
|
+
warn_unreachable = true
|
|
84
|
+
enable_error_code = [
|
|
85
|
+
"ignore-without-code",
|
|
86
|
+
"redundant-expr",
|
|
87
|
+
"truthy-bool",
|
|
88
|
+
]
|
|
89
|
+
|
|
90
|
+
[[tool.mypy.overrides]]
|
|
91
|
+
module = [
|
|
92
|
+
"sympy",
|
|
93
|
+
"sympy.*",
|
|
94
|
+
"mpmath",
|
|
95
|
+
"mpmath.*",
|
|
96
|
+
]
|
|
97
|
+
ignore_missing_imports = true
|
|
98
|
+
|
|
99
|
+
[tool.pytest]
|
|
100
|
+
minversion = "9.0"
|
|
101
|
+
testpaths = ["tests"]
|
|
102
|
+
strict = true
|
|
103
|
+
filterwarnings = ["error"]
|
|
104
|
+
addopts = [
|
|
105
|
+
"-ra",
|
|
106
|
+
"--showlocals",
|
|
107
|
+
]
|
|
108
|
+
log_level = "INFO"
|
|
109
|
+
|
|
110
|
+
[tool.coverage.run]
|
|
111
|
+
branch = true
|
|
112
|
+
source = [
|
|
113
|
+
"src/nomogram",
|
|
114
|
+
"scripts",
|
|
115
|
+
]
|
|
116
|
+
relative_files = true
|
|
117
|
+
|
|
118
|
+
[tool.coverage.report]
|
|
119
|
+
fail_under = 80
|
|
120
|
+
show_missing = true
|
|
121
|
+
exclude_also = ['if __name__ == "__main__":']
|
|
122
|
+
|
|
123
|
+
[tool.ruff.lint]
|
|
124
|
+
extend-select = [
|
|
125
|
+
"ARG",
|
|
126
|
+
"B",
|
|
127
|
+
"C4",
|
|
128
|
+
"PIE",
|
|
129
|
+
"PT",
|
|
130
|
+
"PTH",
|
|
131
|
+
"RET",
|
|
132
|
+
"T20",
|
|
133
|
+
]
|
|
134
|
+
|
|
135
|
+
[tool.ruff.lint.per-file-ignores]
|
|
136
|
+
"tests/**" = ["ARG001"]
|
|
137
|
+
"scripts/**" = ["T20"]
|
|
138
|
+
|
|
139
|
+
[tool.codespell]
|
|
140
|
+
skip = "*.fr.md,uv.lock"
|
|
141
|
+
|
|
142
|
+
[tool.repo-review.ignore]
|
|
143
|
+
PC110 = "ruff format runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
144
|
+
PC140 = "mypy runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
145
|
+
PC160 = "codespell runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
146
|
+
PC190 = "ruff check runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
147
|
+
SEC001 = "zizmor runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
148
|
+
PC901 = "pre-commit.ci is not used; CI replays the hooks itself"
|
|
149
|
+
PC902 = "pre-commit.ci is not used; CI replays the hooks itself"
|
|
150
|
+
PC903 = "pre-commit.ci is not used; CI replays the hooks itself"
|
|
151
|
+
PC180 = "no markdown formatter, by choice (dependency control, hand-written texts)"
|
|
152
|
+
PY007 = "uv run is the task runner, identical on every OS"
|
|
153
|
+
PY004 = "temporary: documentation (Sphinx, Read the Docs) not started yet"
|
|
154
|
+
PC170 = "temporary: no reStructuredText until the documentation exists"
|
|
@@ -0,0 +1,130 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "nomogram"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "Repository of scientific formulas: notations, units, validity domains"
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
authors = [
|
|
7
|
+
{ name = "miki4ia", email = "miki4ia@gmail.com" }
|
|
8
|
+
]
|
|
9
|
+
requires-python = ">=3.12"
|
|
10
|
+
license = "BSD-3-Clause AND CC-BY-4.0 AND CC0-1.0"
|
|
11
|
+
license-files = ["LICENSE", "src/nomogram/data/NOTICE.md"]
|
|
12
|
+
keywords = [
|
|
13
|
+
"scientific computing",
|
|
14
|
+
"formulas",
|
|
15
|
+
"units",
|
|
16
|
+
"dimensional analysis",
|
|
17
|
+
"physics",
|
|
18
|
+
"thermodynamics",
|
|
19
|
+
"geoscience",
|
|
20
|
+
"atmospheric science",
|
|
21
|
+
"meteorology",
|
|
22
|
+
"hydrology",
|
|
23
|
+
"psychrometrics",
|
|
24
|
+
]
|
|
25
|
+
classifiers = [
|
|
26
|
+
"Development Status :: 3 - Alpha",
|
|
27
|
+
"Intended Audience :: Science/Research",
|
|
28
|
+
"Operating System :: OS Independent",
|
|
29
|
+
"Programming Language :: Python :: 3",
|
|
30
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
31
|
+
"Programming Language :: Python :: 3.12",
|
|
32
|
+
"Programming Language :: Python :: 3.13",
|
|
33
|
+
"Topic :: Scientific/Engineering",
|
|
34
|
+
"Topic :: Scientific/Engineering :: Atmospheric Science",
|
|
35
|
+
"Topic :: Scientific/Engineering :: Hydrology",
|
|
36
|
+
"Topic :: Scientific/Engineering :: Physics",
|
|
37
|
+
"Typing :: Typed",
|
|
38
|
+
]
|
|
39
|
+
dependencies = [
|
|
40
|
+
"numpy>=2.0",
|
|
41
|
+
"pint>=0.24.4",
|
|
42
|
+
"sympy>=1.13",
|
|
43
|
+
]
|
|
44
|
+
|
|
45
|
+
[project.urls]
|
|
46
|
+
Homepage = "https://github.com/miki4iaml/nomogram"
|
|
47
|
+
Repository = "https://github.com/miki4iaml/nomogram"
|
|
48
|
+
Issues = "https://github.com/miki4iaml/nomogram/issues"
|
|
49
|
+
Changelog = "https://github.com/miki4iaml/nomogram/blob/main/CHANGELOG.md"
|
|
50
|
+
|
|
51
|
+
[project.optional-dependencies]
|
|
52
|
+
viz = [
|
|
53
|
+
"matplotlib>=3.10.7",
|
|
54
|
+
]
|
|
55
|
+
|
|
56
|
+
[build-system]
|
|
57
|
+
requires = ["uv_build>=0.12.18,<0.13.0"]
|
|
58
|
+
build-backend = "uv_build"
|
|
59
|
+
|
|
60
|
+
[dependency-groups]
|
|
61
|
+
dev = [
|
|
62
|
+
"codespell>=2.4.3",
|
|
63
|
+
"coverage>=7.16.2",
|
|
64
|
+
"mypy>=2.4.0",
|
|
65
|
+
"pre-commit>=4.6.2",
|
|
66
|
+
"pytest>=9.1.1",
|
|
67
|
+
"rdflib>=7.6",
|
|
68
|
+
"ruff>=0.16.9",
|
|
69
|
+
"zizmor>=1.30.1",
|
|
70
|
+
]
|
|
71
|
+
|
|
72
|
+
[tool.mypy]
|
|
73
|
+
python_version = "3.12"
|
|
74
|
+
strict = true
|
|
75
|
+
files = ["src", "tests", "scripts", "docs/examples"]
|
|
76
|
+
warn_unreachable = true
|
|
77
|
+
enable_error_code = ["ignore-without-code", "redundant-expr", "truthy-bool"]
|
|
78
|
+
|
|
79
|
+
[[tool.mypy.overrides]]
|
|
80
|
+
# SymPy and mpmath ship no type information (no py.typed marker).
|
|
81
|
+
module = ["sympy", "sympy.*", "mpmath", "mpmath.*"]
|
|
82
|
+
ignore_missing_imports = true
|
|
83
|
+
|
|
84
|
+
[tool.pytest]
|
|
85
|
+
minversion = "9.0"
|
|
86
|
+
testpaths = ["tests"]
|
|
87
|
+
strict = true
|
|
88
|
+
filterwarnings = ["error"]
|
|
89
|
+
addopts = ["-ra", "--showlocals"]
|
|
90
|
+
log_level = "INFO"
|
|
91
|
+
|
|
92
|
+
[tool.coverage.run]
|
|
93
|
+
branch = true
|
|
94
|
+
# Explicit: the hook script is loaded from its path by importlib.
|
|
95
|
+
source = ["src/nomogram", "scripts"]
|
|
96
|
+
# Same paths on Windows and Linux, so that Codecov can merge reports.
|
|
97
|
+
relative_files = true
|
|
98
|
+
|
|
99
|
+
[tool.coverage.report]
|
|
100
|
+
# Floor, not target: the actual rate is visible in reports and Codecov.
|
|
101
|
+
fail_under = 80
|
|
102
|
+
show_missing = true
|
|
103
|
+
exclude_also = ['if __name__ == "__main__":']
|
|
104
|
+
|
|
105
|
+
[tool.ruff.lint]
|
|
106
|
+
# On top of ruff's default selection, which Dependabot bumps surface in CI.
|
|
107
|
+
extend-select = ["ARG", "B", "C4", "PIE", "PT", "PTH", "RET", "T20"]
|
|
108
|
+
|
|
109
|
+
[tool.ruff.lint.per-file-ignores]
|
|
110
|
+
# Fixtures requested for their side effects look like unused arguments.
|
|
111
|
+
"tests/**" = ["ARG001"]
|
|
112
|
+
# The hook is a command-line tool: printing is its output.
|
|
113
|
+
"scripts/**" = ["T20"]
|
|
114
|
+
|
|
115
|
+
[tool.codespell]
|
|
116
|
+
skip = "*.fr.md,uv.lock"
|
|
117
|
+
|
|
118
|
+
[tool.repo-review.ignore]
|
|
119
|
+
PC110 = "ruff format runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
120
|
+
PC140 = "mypy runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
121
|
+
PC160 = "codespell runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
122
|
+
PC190 = "ruff check runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
123
|
+
SEC001 = "zizmor runs as a local hook through uv run --frozen (single version source: uv.lock)"
|
|
124
|
+
PC901 = "pre-commit.ci is not used; CI replays the hooks itself"
|
|
125
|
+
PC902 = "pre-commit.ci is not used; CI replays the hooks itself"
|
|
126
|
+
PC903 = "pre-commit.ci is not used; CI replays the hooks itself"
|
|
127
|
+
PC180 = "no markdown formatter, by choice (dependency control, hand-written texts)"
|
|
128
|
+
PY007 = "uv run is the task runner, identical on every OS"
|
|
129
|
+
PY004 = "temporary: documentation (Sphinx, Read the Docs) not started yet"
|
|
130
|
+
PC170 = "temporary: no reStructuredText until the documentation exists"
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
# SPDX-FileCopyrightText: 2026 Miki
|
|
2
|
+
# SPDX-License-Identifier: BSD-3-Clause
|
|
3
|
+
|
|
4
|
+
"""nomogram: a repository of scientific formulas.
|
|
5
|
+
|
|
6
|
+
Submodules are imported on demand, so that ``import nomogram`` stays
|
|
7
|
+
light: :mod:`nomogram.units` (pint), :mod:`nomogram.expression`
|
|
8
|
+
(SymPy), :mod:`nomogram.semantics` (bundled QUDT and CF subsets),
|
|
9
|
+
:mod:`nomogram.model` and :mod:`nomogram.catalog` (formulations), and
|
|
10
|
+
:mod:`nomogram.comparison`.
|
|
11
|
+
"""
|
|
12
|
+
|
|
13
|
+
from importlib.metadata import version
|
|
14
|
+
|
|
15
|
+
__all__ = ["__version__"]
|
|
16
|
+
|
|
17
|
+
__version__ = version("nomogram")
|