aiphoria 0.0.1__tar.gz → 0.8.0__tar.gz

aiphoria-0.8.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 European Forest Institute
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

aiphoria-0.8.0/MANIFEST.in

@@ -0,0 +1,19 @@
+recursive-include src/aiphoria/core/datavisualizer_data *
+recursive-include src/aiphoria/core/network_graph_data *
+recursive-include src/aiphoria/data example_scenario.xlsx
+
+prune src/aiphoria/core/datavisualizer_data/.idea
+prune src/aiphoria/core/datavisualizer_data/.vscode
+
+prune src/aiphoria/core/network_graph_data/.idea
+prune src/aiphoria/core/network_graph_data/.vscode
+
+prune .idea
+prune .vscode
+prune .git
+
+# Exclude all dotfiles globally
+global-exclude .*
+global-exclude __pycache__/*
+global-exclude src/aiphoria/__pycache__/*
+global-exclude src/aiphoria/core/__pycache__/*

aiphoria-0.8.0/PKG-INFO

@@ -0,0 +1,119 @@
+Metadata-Version: 2.4
+Name: aiphoria
+Version: 0.8.0
+Summary: Dynamic MFA tool
+Author-email: Janne Järvikylä <janne.jarvikyla@efi.int>
+Maintainer-email: Janne Järvikylä <janne.jarvikyla@efi.int>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/EuropeanForestInstitute/aiphoria
+Project-URL: Issues, https://github.com/EuropeanForestInstitute/aiphoria/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: pandas==2.2.2
+Requires-Dist: Pillow>=10.0.0
+Requires-Dist: plotly==6.0.0
+Requires-Dist: openpyxl==3.1.3
+Requires-Dist: scipy
+Requires-Dist: matplotlib
+Requires-Dist: xlrd
+Requires-Dist: xlwt
+Requires-Dist: tqdm
+Requires-Dist: myst-parser
+Requires-Dist: sphinx-rtd-theme
+Requires-Dist: IPython
+Requires-Dist: xlsxwriter
+Requires-Dist: importlib
+Dynamic: license-file
+
+<h1>
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/_static/aiphoria-logo.png" height="50">
+    <img alt="aiphoria logo" src="https://raw.githubusercontent.com/EuropeanForestInstitute/aiphoria/main/docs/_static/aiphoria-logo.png" height="160">
+  </picture>
+</h1>
+
+## Python package for assessing and visualizing dynamic wood material flows
+
+> ℹ️ _This package is under continuous development_
+
+aiphoria is Python package that facilitates the assessment of wood materials flows, associated carbon stocks, and stock changes, as well as and their visualization over time.
+**aiphoria** builds on top of [ODYM - Open Dynamic Material Systems Model](https://github.com/IndEcol/ODYM).
+
+## Features:
+**aiphoria** allows you to:
+- **Solve flows** provided both in absolute and relative (%) values, for example semi-finished wood product statistics (absolute values) to end-uses (relative values)
+- **Conduct dynamic MFA as well as temporary carbon storage assessment**
+- **Visualize material flows** through a Sankey diagram and provided timestep.
+
+## Use cases:
+
+**aiphoria** is ideal for:
+- **Any temporal and spatial situation where material systems want to be assessed**
+- **Product sink/stock effects**
+
+
+# Installation
+
+**aiphoria** is available at Python Package Index (PyPi) and as source distribution in [Github](https://github.com/EuropeanForestInstitute/aiphoria/wiki)<br>
+
+## Install from PyPi
+```
+pip install aiphoria
+```
+
+## Install from GitHub
+```
+pip install git+https://github.com/EuropeanForestInstitute/aiphoria.git
+```
+
+# How to use
+
+## Showcase
+**aiphoria** includes helper function to showcase example scenario with visualizations.<br>
+Showcase / example scenario can be run by the following code:
+
+```python
+from aiphoria.example import run_example
+
+run_example(remove_existing_output_dir=True)
+```
+
+Network and Sankey visualizations are opened automatically in browser and output is generated<br>
+inside user home directory to directory called "aiphoria_example_scenario".<br>
+
+## Advanced usage
+For the users who are already familiar using **aiphoria** the package exposes function for running
+scenarios by using the one-liner:
+
+```python
+from aiphoria.runner import run_scenarios
+
+run_scenarios(path_to_settings_file="path/to/scenario/file.xlsx",
+              path_to_output_dir="~/scenario_result",
+              remove_existing_output_dir=False)
+```
+
+Using parameter **path_to_output_dir** overrides the output path defined in scenario file.<br>
+This makes easier to change target from Python script itself or when running multiple scenarios in batch.<br>
+Parameters:
+- path_to_settings_file (string): Path to scenario settings file
+- path_to_output_dir (string): Path to directory where results are saved
+- remove_existing_output_dir: If True then existing output directory is deleted (defaults to False). If directory already exists then error is raised and execution is stopped
+
+## Documentation
+
+Online documentation can be found in [GitHub wiki](https://github.com/EuropeanForestInstitute/aiphoria/wiki).
+
+
+## Support:
+
+If you have any questions or need help, do not hesitate to contact us:
+- [cleo.orfanidou@efi.int](mailto:cleo.orfanidou@efi.int)
+- [janne.jarvikyla@efi.int](mailto:janne.jarvikyla@efi.int)
+
+

aiphoria-0.8.0/README.md

@@ -0,0 +1,87 @@
+<h1>
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="docs/_static/aiphoria-logo.png" height="50">
+    <img alt="aiphoria logo" src="https://raw.githubusercontent.com/EuropeanForestInstitute/aiphoria/main/docs/_static/aiphoria-logo.png" height="160">
+  </picture>
+</h1>
+
+## Python package for assessing and visualizing dynamic wood material flows
+
+> ℹ️ _This package is under continuous development_
+
+aiphoria is Python package that facilitates the assessment of wood materials flows, associated carbon stocks, and stock changes, as well as and their visualization over time.
+**aiphoria** builds on top of [ODYM - Open Dynamic Material Systems Model](https://github.com/IndEcol/ODYM).
+
+## Features:
+**aiphoria** allows you to:
+- **Solve flows** provided both in absolute and relative (%) values, for example semi-finished wood product statistics (absolute values) to end-uses (relative values)
+- **Conduct dynamic MFA as well as temporary carbon storage assessment**
+- **Visualize material flows** through a Sankey diagram and provided timestep.
+
+## Use cases:
+
+**aiphoria** is ideal for:
+- **Any temporal and spatial situation where material systems want to be assessed**
+- **Product sink/stock effects**
+
+
+# Installation
+
+**aiphoria** is available at Python Package Index (PyPi) and as source distribution in [Github](https://github.com/EuropeanForestInstitute/aiphoria/wiki)<br>
+
+## Install from PyPi
+```
+pip install aiphoria
+```
+
+## Install from GitHub
+```
+pip install git+https://github.com/EuropeanForestInstitute/aiphoria.git
+```
+
+# How to use
+
+## Showcase
+**aiphoria** includes helper function to showcase example scenario with visualizations.<br>
+Showcase / example scenario can be run by the following code:
+
+```python
+from aiphoria.example import run_example
+
+run_example(remove_existing_output_dir=True)
+```
+
+Network and Sankey visualizations are opened automatically in browser and output is generated<br>
+inside user home directory to directory called "aiphoria_example_scenario".<br>
+
+## Advanced usage
+For the users who are already familiar using **aiphoria** the package exposes function for running
+scenarios by using the one-liner:
+
+```python
+from aiphoria.runner import run_scenarios
+
+run_scenarios(path_to_settings_file="path/to/scenario/file.xlsx",
+              path_to_output_dir="~/scenario_result",
+              remove_existing_output_dir=False)
+```
+
+Using parameter **path_to_output_dir** overrides the output path defined in scenario file.<br>
+This makes easier to change target from Python script itself or when running multiple scenarios in batch.<br>
+Parameters:
+- path_to_settings_file (string): Path to scenario settings file
+- path_to_output_dir (string): Path to directory where results are saved
+- remove_existing_output_dir: If True then existing output directory is deleted (defaults to False). If directory already exists then error is raised and execution is stopped
+
+## Documentation
+
+Online documentation can be found in [GitHub wiki](https://github.com/EuropeanForestInstitute/aiphoria/wiki).
+
+
+## Support:
+
+If you have any questions or need help, do not hesitate to contact us:
+- [cleo.orfanidou@efi.int](mailto:cleo.orfanidou@efi.int)
+- [janne.jarvikyla@efi.int](mailto:janne.jarvikyla@efi.int)
+
+

aiphoria-0.8.0/pyproject.toml

@@ -0,0 +1,65 @@
+[build-system]
+requires = ["setuptools >= 77.0.3"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "aiphoria"
+version = "0.8.0"
+authors = [
+    { name="Janne Järvikylä", email="janne.jarvikyla@efi.int" },
+]
+maintainers = [
+    { name="Janne Järvikylä", email="janne.jarvikyla@efi.int"},
+]
+description = "Dynamic MFA tool"
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "numpy",
+    "pandas==2.2.2",
+    "Pillow>=10.0.0",
+    "plotly==6.0.0",
+    "openpyxl==3.1.3",
+    "scipy",
+    "matplotlib",
+    "xlrd",
+    "xlwt",
+    "tqdm",
+    "myst-parser",
+    "sphinx-rtd-theme",
+    "IPython",
+    "xlsxwriter",
+    "importlib",
+]
+classifiers = [
+    # How mature the project is?
+    # 3 - Alpha
+    # 4 - Beta
+    # 5 - Production/Stable
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+license = "MIT"
+license-files = ["LICEN[CS]E*"]
+
+[project.urls]
+Homepage = "https://github.com/EuropeanForestInstitute/aiphoria"
+Issues = "https://github.com/EuropeanForestInstitute/aiphoria/issues"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+# Exclude dotfiles
+[tools.setuptools.exclude-package-data]
+"aiphoria.core.datavisualizer_data" = [".*"]
+"aiphoria.core.network_graph_data" = [".*"]
+
+# # Include HTML template files
+[tools.setuptools.package-data]
+"aiphoria.data" = ["example_scenario.xlsx"]
+# aiphoria = ["*.txt", "*.tst"]
+# "aiphoria.core.datavisualizer_data" = ["", "*.*"]
+# "aiphoria.core.network_graph_data" = ["*.*"]
+
+

aiphoria-0.8.0/src/aiphoria/__init__.py

@@ -0,0 +1,59 @@
+__version__ = "0.0.1"
+
+# Import aiphoria core files, classes and functions
+from . import core
+from .core.builder import (
+    init_builder,
+    build_results,
+    build_dataprovider,
+    build_datachecker,
+)
+
+from .core.dataprovider import DataProvider
+from .core.datachecker import DataChecker
+from .core.datastructures import (
+    Scenario,
+    ScenarioData,
+    Process,
+    Flow,
+    Stock,
+    Indicator,
+)
+
+from .core.parameters import (
+    ParameterName,
+    ParameterFillMethod,
+)
+
+from .core.utils import (
+    create_output_directory,
+    setup_current_working_directory,
+    set_output_directory,
+    get_output_directory,
+)
+
+from .core.logger import log
+from .runner import run_scenarios
+
+__all__ = [
+    "core",
+    "init_builder",
+    "build_results",
+    "build_dataprovider",
+    "build_datachecker",
+    "DataProvider",
+    "DataChecker",
+    "Scenario",
+    "Process",
+    "Flow",
+    "Stock",
+    "Indicator",
+    "ParameterName",
+    "ParameterFillMethod",
+    "create_output_directory",
+    "setup_current_working_directory",
+    "log",
+    "set_output_directory",
+    "get_output_directory",
+    "run_scenarios",
+]

aiphoria-0.8.0/src/aiphoria/core/__init__.py

@@ -0,0 +1,55 @@
+"""
+    aiphoria core module
+"""
+
+from .builder import (
+    init_builder,
+    build_results,
+    build_dataprovider,
+    build_datachecker,
+    build_and_solve_scenarios,
+)
+
+from .dataprovider import DataProvider
+from .datachecker import DataChecker
+from .datastructures import (
+    Scenario,
+    ScenarioData,
+    Process,
+    Flow,
+    Stock,
+    Indicator,
+)
+
+from .flowsolver import FlowSolver
+from .parameters import ParameterName, ParameterFillMethod, StockDistributionType
+from .datavisualizer import DataVisualizer
+from .network_graph import NetworkGraph
+from .logger import log
+from .utils import (
+    create_output_directory,
+)
+
+__all__ = [
+    "init_builder",
+    "build_results",
+    "build_dataprovider",
+    "build_datachecker",
+    "build_and_solve_scenarios",
+    "DataProvider",
+    "DataChecker",
+    "Scenario",
+    "ScenarioData",
+    "Process",
+    "Flow",
+    "Stock",
+    "Indicator",
+    "FlowSolver",
+    "DataVisualizer",
+    "NetworkGraph",
+    "ParameterName",
+    "ParameterFillMethod",
+    "StockDistributionType",
+    "log",
+    "create_output_directory",
+]