aiphoria 0.0.1__py3-none-any.whl → 0.8.0__py3-none-any.whl

aiphoria-0.8.0.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,40 @@
+aiphoria/__init__.py,sha256=sLmNlsKsxrXYkEs138mmCVprV_JVHEebtWce8erZD1A,1198
+aiphoria/example.py,sha256=nfAVgXUFiMd3RKCYhMjd9pTo1vtqSpEjrCLnkoVn8z8,2625
+aiphoria/runner.py,sha256=Oo1o9F3oWSuMhoJ59oytcRe2Y-VnsvZtApBMue99kP4,33626
+aiphoria/core/__init__.py,sha256=DEw_CnXbEjkIJUvXF2E52e6RHwljlZeLS7-uGFPfOzo,1147
+aiphoria/core/builder.py,sha256=PS44eKqphdSBUdmGGOoMQ3BQ3LA1IV7l0RO0hzXB8UQ,12845
+aiphoria/core/datachecker.py,sha256=boiz5g7_QGsPcm4fU0VJ3o1_-yUjQdpcgQxP2OFOSZQ,86832
+aiphoria/core/dataprovider.py,sha256=l_yIyvPEkI1TqfNp6BUYMbJzSbaN1Qu8lSqbRF7Er3o,34476
+aiphoria/core/datastructures.py,sha256=F6kXMXXGS2eExfKImjRkMw447rF65_3FdKgst0wDkyE,50484
+aiphoria/core/datavisualizer.py,sha256=QqPkZyHGGSfu2bi_OCU518AorPzZpZ60mnYTxhV5_-4,21080
+aiphoria/core/flowmodifiersolver.py,sha256=IuGrB92I36M5GbjcMf08wZIJRtCre3jVMOlwOnYTEXY,97164
+aiphoria/core/flowsolver.py,sha256=DM2oqgt2LR_KDoEU9zk3ZdujESgIJCh4gqqXN2pglGw,67068
+aiphoria/core/logger.py,sha256=qTCju8Ad6KnFFWaQ-Jx14lXTikrAHEIKW_dFVXJGH1I,2838
+aiphoria/core/network_graph.py,sha256=cP2WKN7ogZY8ohR7UvYVTIwdXBONxs2s1QrjqIqIf88,6183
+aiphoria/core/parameters.py,sha256=RAYWng9AtLiRgI1o_No5_V7k55HXvJMtfsu5y2XZEQ0,9121
+aiphoria/core/types.py,sha256=xdJYAWMlENHHCvg7oCXTWJ3ISbvL8wvJzw2LRGLE8wg,392
+aiphoria/core/utils.py,sha256=L1u8W4FH6vk-iWBo-3AfCnRzWSpTcGiFGE35jGKtQmY,14502
+aiphoria/core/visualizer_parameters.py,sha256=R4II0H63KKkYhcg2bb_QgwsNNX0w9R24FoGpYyUAsV8,221
+aiphoria/core/datavisualizer_data/LICENSE,sha256=VH8Fr9fxI7Lk0rGUHz78igso-4jJoe_fzZ9E3nXlRgY,1105
+aiphoria/core/datavisualizer_data/datavisualizer_plotly.html,sha256=-rWy2GIRpBiXwQxL6GBd3kcV1Y6XIgpLF8H3Vm492_k,281351
+aiphoria/core/datavisualizer_data/pako.min.js,sha256=e3o7jbTXtlhGuAfxMJaIqJVZYdveVThpSGKmxcvJMs8,46859
+aiphoria/core/datavisualizer_data/plotly-3.0.0.min.js,sha256=B9O0NR9uvNnjiQ5XoeDwysQzYXgYbmgbX_bj9EyJop0,4652792
+aiphoria/core/network_graph_data/ECHARTS_LICENSE,sha256=SbvpEU5JIU3yzMMkyzrI0dGqHDoJR_lMKGdl6GZHsy4,11558
+aiphoria/core/network_graph_data/echarts_min.js,sha256=BuNYaR9_pqhRQF2KveiZegb5tro8uZa6C4v4BroB7j8,1030929
+aiphoria/core/network_graph_data/network_graph.html,sha256=ocuNGjhIayVGd5vd6zHNJCCN2DhjFAkq_R7WwryfIF8,3502
+aiphoria/core/network_graph_data/network_graph.js,sha256=UjS46PJs01fxhtcQlxQ1vbN_SyhjbxU6syWCLLtS2lo,49109
+aiphoria/data/example_scenario.xlsx,sha256=0hrA-3jk049D4aey76cpa74aQtnUU1vqzkjiS8c0MUE,130840
+aiphoria/lib/docs/dynamic_stock.py,sha256=Z3rcBWKTrsFCiwqB8OhW27LVPRtYQ6KJocDfb51ppI4,5163
+aiphoria/lib/odym/modules/ODYM_Classes.py,sha256=a2r-0QbBKpsKFo8vdcI6w6RPsP-t2OktbNHBegU_jac,20986
+aiphoria/lib/odym/modules/ODYM_Functions.py,sha256=QXGQBYHxouWsGna0NcH2SDCNY6ryOxJL4hPAP7yMuOU,61171
+aiphoria/lib/odym/modules/__init__.py,sha256=frcCV1k9oG9oKj3dpUqdJg1PxRT2RSN_XKdLCPjaYaY,2
+aiphoria/lib/odym/modules/dynamic_stock_model.py,sha256=F5b1OCs8AdAzeTb8tKnZbh5L-yvcTFtgQxpKOhC0gTw,51580
+aiphoria/lib/odym/modules/test/DSM_test_known_results.py,sha256=JCJsR2MMFleCslAc_-uZXT9kvLIqSJE7Zj50ycpoLGg,52947
+aiphoria/lib/odym/modules/test/ODYM_Classes_test_known_results.py,sha256=3g9l1ydkxjjL8Puy0AvDkpEdxHQVK_Vg8tM7Gy3VSfA,6015
+aiphoria/lib/odym/modules/test/ODYM_Functions_test_known_results.py,sha256=TMd-bOU3Q-UNWBG8Ou3Nr1NatxHrK2dVoLVE1EfUbEY,5758
+aiphoria/lib/odym/modules/test/__init__.py,sha256=M9j1NuexsmXRO0O_LLRNrLF7fEfPAHWIxm90hC6gV3I,27
+aiphoria-0.8.0.dist-info/licenses/LICENSE,sha256=FAUUjPq0h-9beaGzhfVS_S_IDSpghGGAIq8lglo_gK4,1103
+aiphoria-0.8.0.dist-info/METADATA,sha256=5T4uhfqbLaw8rSy28bXdJlsLYf4Bubv8eY8KsL1NM4Q,4389
+aiphoria-0.8.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+aiphoria-0.8.0.dist-info/top_level.txt,sha256=sSoiLUL4dyCtQmvkcRN01QT8p9vmFo5hEP6UZa5SW30,9
+aiphoria-0.8.0.dist-info/RECORD,,

{aiphoria-0.0.1.dist-info → aiphoria-0.8.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

aiphoria-0.8.0.dist-info/licenses/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.0.1.dist-info/METADATA

@@ -1,5 +0,0 @@
-Metadata-Version: 2.4
-Name: aiphoria
-Version: 0.0.1
-Summary: Reserved package name
-Author: EuropeanForestInstitute

aiphoria-0.0.1.dist-info/RECORD

@@ -1,5 +0,0 @@
-aiphoria/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-aiphoria-0.0.1.dist-info/METADATA,sha256=jB_oGJu5xftw7_ZMVkyPW-Kaa-Hkv-RCBkZ2KCqlrwI,120
-aiphoria-0.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-aiphoria-0.0.1.dist-info/top_level.txt,sha256=sSoiLUL4dyCtQmvkcRN01QT8p9vmFo5hEP6UZa5SW30,9
-aiphoria-0.0.1.dist-info/RECORD,,