Metadata-Version: 2.5
Name: pysuto
Version: 0.1.0rc1
Summary: Python-based Supply-Use Table Optimiser: sigma-weighted reconciliation of supply-use tables from conflicting sources
Project-URL: Homepage, https://github.com/florihu/pySUTO
Project-URL: Repository, https://github.com/florihu/pySUTO
Project-URL: Issues, https://github.com/florihu/pySUTO/issues
Author-email: Florian Huber <florian.huber1@wu.ac.at>
License-Expression: MIT
License-File: LICENSE
Keywords: copper,data reconciliation,material flow analysis,supply-use tables,uncertainty
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.9
Requires-Dist: clarabel>=0.11.1
Requires-Dist: matplotlib>=3.9.2
Requires-Dist: numpy>=1.26.4
Requires-Dist: openpyxl>=3.1.5
Requires-Dist: pandas<3,>=2.3.3
Requires-Dist: pyarrow>=21.0.0
Requires-Dist: pyyaml>=6.0.3
Requires-Dist: scipy>=1.13.1
Provides-Extra: dev
Requires-Dist: build; extra == 'dev'
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: nbclient; extra == 'dev'
Requires-Dist: plotly>=6.3.0; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: sparse; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Requires-Dist: vulture; extra == 'dev'
Provides-Extra: sankey
Requires-Dist: kaleido>=1.4.0; extra == 'sankey'
Requires-Dist: plotly>=6.3.0; extra == 'sankey'
Provides-Extra: tutorial
Requires-Dist: jupyter; extra == 'tutorial'
Requires-Dist: kaleido>=1.4.0; extra == 'tutorial'
Requires-Dist: plotly>=6.3.0; extra == 'tutorial'
Provides-Extra: uncprop
Requires-Dist: scikit-sparse; extra == 'uncprop'
Description-Content-Type: text/markdown

# pySUTO

pySUTO (Python-based Supply-Use Table Optimiser) reconciles supply-use tables from
conflicting sources. Each source datum carries an uncertainty; a sigma-weighted quadratic
programme, solved with Clarabel, returns the flows that agree with the accounting
constraints at the smallest weighted distance from the data, and the posterior uncertainty
of every flow. It is built for material flow analysis and was developed on copper.

```
pip install pysuto
pip install "pysuto[tutorial]"
pysuto tutorial DEST
```

The second line adds Jupyter and Plotly; `pysuto tutorial DEST` copies the tutorial
notebooks into the directory `DEST`. Without a Chrome browser, run `plotly_get_chrome -y`
once: Kaleido needs it to write the Sankey figures. Python 3.9 or newer is required.

`python -m pysuto run` requires `--case` and `--data-dir`. `--case` is a bundled alias
(`toy`, `toy_coproduct`), a dotted module or a file path, each naming a module that declares
a `CASE`; the package ships no study case. The copper chain runs only from a repository
checkout (`--case scripts/copper.py`) with the licensed original data.

pySUTO is licensed under the MIT License. Documentation, the method, the citation file and
the source are in the GitHub repository:
https://github.com/florihu/pySUTO
