nomogram 0.1.0__py3-none-any.whl

nomogram-0.1.0.dist-info/METADATA

@@ -0,0 +1,125 @@
+Metadata-Version: 2.4
+Name: nomogram
+Version: 0.1.0
+Summary: Repository of scientific formulas: notations, units, validity domains
+Keywords: scientific computing,formulas,units,dimensional analysis,physics,thermodynamics,geoscience,atmospheric science,meteorology,hydrology,psychrometrics
+Author: miki4ia
+Author-email: miki4ia <miki4ia@gmail.com>
+License-Expression: BSD-3-Clause AND CC-BY-4.0 AND CC0-1.0
+License-File: LICENSE
+License-File: src/nomogram/data/NOTICE.md
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Atmospheric Science
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Classifier: Topic :: Scientific/Engineering :: Physics
+Classifier: Typing :: Typed
+Requires-Dist: numpy>=2.0
+Requires-Dist: pint>=0.24.4
+Requires-Dist: sympy>=1.13
+Requires-Dist: matplotlib>=3.10.7 ; extra == 'viz'
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/miki4iaml/nomogram
+Project-URL: Repository, https://github.com/miki4iaml/nomogram
+Project-URL: Issues, https://github.com/miki4iaml/nomogram/issues
+Project-URL: Changelog, https://github.com/miki4iaml/nomogram/blob/main/CHANGELOG.md
+Provides-Extra: viz
+Description-Content-Type: text/markdown
+
+# nomogram
+
+**English** | [Français](README.fr.md)
+
+[![CI](https://github.com/miki4iaml/nomogram/actions/workflows/ci.yml/badge.svg?branch=develop)](https://github.com/miki4iaml/nomogram/actions/workflows/ci.yml)
+[![CodeQL](https://github.com/miki4iaml/nomogram/actions/workflows/github-code-scanning/codeql/badge.svg)](https://github.com/miki4iaml/nomogram/actions/workflows/github-code-scanning/codeql)
+[![codecov](https://codecov.io/gh/miki4iaml/nomogram/graph/badge.svg?branch=develop)](https://codecov.io/gh/miki4iaml/nomogram)
+[![Python](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fmiki4iaml%2Fnomogram%2Fdevelop%2Fpyproject.toml)](pyproject.toml)
+[![License](https://img.shields.io/github/license/miki4iaml/nomogram)](LICENSE)
+[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+[![Checked with mypy](https://www.mypy-lang.org/static/mypy_badge.svg)](https://mypy-lang.org/)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-fe5196)](https://www.conventionalcommits.org/en/v1.0.0/)
+
+A repository of scientific formulas: alternative notations across
+authors and conventions, parameter units (including empirical ones),
+validity domains, LaTeX rendering and symbolic computation.
+
+Pure Python, built on SymPy, numpy and pint; it works on an offline
+workstation (no online engine).
+
+> Early stage project (alpha).
+
+## Installation
+
+```
+pip install nomogram          # core
+pip install "nomogram[viz]"   # with plots (matplotlib)
+```
+
+## Installation from source
+
+```
+git clone https://github.com/miki4iaml/nomogram.git
+cd nomogram
+uv sync
+```
+
+Python 3.12 or later. Plots need the `viz` extra (matplotlib):
+`uv sync --extra viz`.
+
+## Example
+
+Every saturation vapour pressure formulation of the catalog against the
+IAPWS reference; curves stop where a formulation leaves its stated
+validity domain ([script](docs/examples/saturation_vapour_pressure.py)):
+
+```python
+import numpy as np
+from nomogram.catalog import catalog
+from nomogram.comparison import compare
+from nomogram.plot import plot_deviations  # extra viz
+from nomogram.units import Q_
+
+formulations = catalog().formulations_of("SaturationVapourPressureOverWater")
+reference = catalog().formulations["iapws_sr1_86"]
+temperatures = Q_(np.linspace(-60, 110, 341), "degC")
+
+table = compare(formulations, reference, {"ThermodynamicTemperature": temperatures})
+plot_deviations(table)
+```
+
+![Deviation of saturation vapour pressure formulations from IAPWS](https://raw.githubusercontent.com/miki4iaml/nomogram/v0.1.0/docs/images/saturation-vapour-pressure.png)
+
+## Usage
+
+The table holds the values and the relative deviations, by formulation;
+values outside a formulation's validity domain are NaN unless asked
+otherwise (`outside="ignore"`). Formulations also chain, for instance
+the absolute humidity from any saturation vapour pressure formulation:
+
+```python
+from nomogram.comparison import compose
+
+ha = compose(catalog().formulations["mass_concentration_ideal_gas"], {"e_s": reference})
+ha.evaluate(RH=Q_(100, "percent"), T=Q_(20, "degC")).to("g/m^3")  # 17.29
+```
+
+Each formulation keeps its units, validity domain, temperature scale and
+references. The vocabulary is mapped in [docs/rosetta.md](docs/rosetta.md).
+
+## Contributing
+
+References to integrate, information or corrections about catalog
+entries, new formulas and code are all welcome: see the
+[ways to contribute](.github/CONTRIBUTING.md#ways-to-contribute) and
+the [catalog guide](docs/catalog.md).
+
+## License
+
+[BSD-3-Clause](LICENSE).

nomogram-0.1.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+nomogram/__init__.py,sha256=dnh9kxpKjQp6Ud49RnzmRmG9Y3jd_gOEeTzvqEJtArI,531
+nomogram/catalog.py,sha256=qKUZVlMy5gY6AUL8r0zMlkw3QSR7vc0pcuQYsiOlV6o,20070
+nomogram/comparison.py,sha256=51H-l-ZeXLEFhrHef9taIoUO1s4xcyPEKjH_OkhJ8Y4,11093
+nomogram/data/NOTICE.md,sha256=p_gPui-v_TZ8qizfx4K3eCTtUwb9Alj9YH14hrolf9I,1060
+nomogram/data/catalog/humidity.toml,sha256=bDtaIWLXXeBEc80PgWx9g0T8Nn3E0Ej_-g9tcpdYmTw,23802
+nomogram/data/semantics.json,sha256=2mnt9urXADhzmflW8bqQ9Pi0IQ3yNLVpFdA1fXl2W3w,12341
+nomogram/expression.py,sha256=I8uY4xbuNQLaB7vidLTusXlemQwFF0t9cnTG6E1uqos,8481
+nomogram/model.py,sha256=oYzJ9bPIKkh2OJWcFZi7qpdc_V9FOnXFFA8FqbA_XuM,19222
+nomogram/plot.py,sha256=SNtlxzfoJ7Ao9jS5U2TeLgNjmkreYiUclodoTraJw04,5857
+nomogram/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+nomogram/semantics.py,sha256=KFj9tNc70OxGeHwgehSrB1-1QTtF9u7pOVN1VGQe6Do,9919
+nomogram/units.py,sha256=68KC9j_V4sLqGdOmBDWRszrrJr-0I3bzHjtDgFSybE0,4299
+nomogram-0.1.0.dist-info/licenses/LICENSE,sha256=uYLcXa0PWs629lm_YY8FRHf-N1TJenb4k1JSq5kvjEk,1491
+nomogram-0.1.0.dist-info/licenses/src/nomogram/data/NOTICE.md,sha256=p_gPui-v_TZ8qizfx4K3eCTtUwb9Alj9YH14hrolf9I,1060
+nomogram-0.1.0.dist-info/WHEEL,sha256=7hzKWg-J8I3Buqyw5tBii5z_MmAVsDYXXijd_QAtNZ8,81
+nomogram-0.1.0.dist-info/METADATA,sha256=cBrlcYMILMfUopymI6t83qR6gaucqvKnagwDyaYqB3w,5379
+nomogram-0.1.0.dist-info/RECORD,,

nomogram-0.1.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.12.18
+Root-Is-Purelib: true
+Tag: py3-none-any

nomogram-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,28 @@
+BSD 3-Clause License
+
+Copyright (c) 2026, Miki
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

nomogram-0.1.0.dist-info/licenses/src/nomogram/data/NOTICE.md

@@ -0,0 +1,25 @@
+# Third-party data bundled with nomogram
+
+`semantics.json` is generated by `scripts/extract_semantics.py` from the
+sources below. Never edit it by hand.
+
+## QUDT
+
+Quantity kinds and unit definitions are extracted from
+[QUDT](https://qudt.org/) release 3.5.2, © QUDT.org, licensed under the
+[Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/)
+(CC BY 4.0).
+
+Changes: a subset of quantity kinds and units was selected and
+restructured as JSON; nomogram adds the scale type and point/difference
+typing of each kind, the units QUDT does not declare for some kinds
+(`added_units`), the pint expression of each unit, and the link from
+each kind to CF standard names. Links from QUDT's `wikidataMatch` are
+recorded as SKOS close matches, with the extraction date as their
+verification date.
+
+## CF standard names
+
+Standard names and canonical units are extracted from the
+[CF standard name table](https://cfconventions.org/) version 95,
+published under [CC0 1.0](https://creativecommons.org/publicdomain/zero/1.0/).