aiphoria v0.9.1

Release notes

Last modification time of settings file is now included in Sankey visualization if scenario is built with parameter include_metadata as True.

aiphoria v0.9

Release notes

Last modification time of settings file is now included in Sankey visualization if scenario is built with parameter include_metadata as True.

aiphoria v0.8.5

Release notes

Included parameter to include settings file metadata in Sankey visualization. Now optionally filename is shown in Scenarios-menu if scenario is built using include_metadata as True.

aiphoria v0.8.3

Release notes

Removed unnecessary library dependencies

aiphoria v0.8.4

Release notes

Updated version number to test build workflow

aiphoria v0.8

Release notes

This version restructured the project for Python package. Now package can be installed either from PyPI or from GitHub.

Showcase feature for new users

aiphoria now has showcase feature that uses example scenario data and creates both data and visualizations using one function call:

from aiphoria.example import run_example

run_example(remove_existing_output_dir=True)

Advanced use case

aiphoria now has feature that allows user to run scenarios using one function call:

from aiphoria.runner import run_scenarios

# First parameter = Path to settings file
# Second parameter = Path to output directory where output is saved
# Third parameter = Remove existing output directory if exists (default = False)
run_scenarios("/path/to/settings/file.xlsx", "/path/to/output/dir", True)

Running aiphoria scenarios in batches is now easier and can be easily done from batch file.

Installing from PyPI (Python Package Index)

aiphoria package is now available at PyPI and can be installed using pip:

pip install aiphoria

Installing from GitHub

aiphoria package can be also installed from GitHub using pip:

pip install git+https://github.com/EuropeanForestInstitute/aiphoria.git

aiphoria v0.7

Release notes

This version improves interactive Sankey visualization, fixes to flow modifier functionality, and adds multi-scenario comparison to Sankey graph

Improved Sankey visualization

Now all scenarios are combined and included to the same Sankey visualization file.
This change allows to compare values between scenarios possible.
Also Sanky interactive visualization UI has been updated.

Improved Sankey visualization data handling

Sankey visualization data is now gzip-compressed so Sankey output file is smaller

Fixes to flow modifier

Fixed resolving flow modifiers when multiple flow modifiers were affecting the same source process.
Added also more informative error messages when using Constrained-mode:

• now error message will show maximum values what are able to achieve when trying to apply flow modifiers

aiphoria v0.6

Release notes

This version brings improvements to interactive visualizations, alternative scenario solving, documentation, and data error checking.

Updated interactive visualizations

Both interactive visualizations are now more performant and include many quality-of-life updates such as:

• Showing indicator values for processes and flows
• Sankey visualization now supports loading even bigger scenarios
• Changing years in both visualizations using arrow left / arrow right keys
• Sankey visualization: apply current year processes position to all other years
• Sankey visualization: copy all positions for all years to clipboard. This data can be pasted back to scenario file for making stable process placement between runs
• Sankey visualization: editing process position manually

Constrained and unconstrained scenario solvers

Introduced two solvers for scenario solving:

• Unconstrained solver will introduce virtual flows if applying flow modifiers cause missing flows
• Constrained solver will try to apply all flow modifiers and will stop if any process report missing flows
  Unconstrained solver is good fit for explorative scenarios while constrained solver is for normative scenarios. Constrained solver will show how much actual flows are missing so that the scenario can be solved.

Flow prioritization

Now it's possible to set list of flows that skip stock accumulation. This can be used to mark flows that go directly from production to export and do not stay in-use.

Improved data checking step

More checks are done when loading scenario and gives better error messages.

Online documentation

aiphoria documentation is now available as wiki at https://github.com/EuropeanForestInstitute/aiphoria/wiki
Wiki is continuously updated between version releases.

aiphoria v0.5

This version brings a significant number of new features, enhancing functionality and user experience. Here’s what’s new:

Flow prioritization
Feature to bypass stock inflow for certain flows. Can be used e.g. when modeling trade flows (import/export). Prioritization can be defined for for either process location or for transformation stages.

Flow merging
Relative flow with 100 % outflow share can be used to "merge" other relative outflows by removing those flows.

Scenarios
Feature to run multiple alternative scenarios by introducing flow variations to initial scenario.

Indicators
Flows and stocks now track arbitrary number of user-defined indicators. Indicator value is proportional value to flow baseline value.

** Outputs written also as CSV **
Scenarios can produce output as CSV files. These files contain information about process inflows and outflows, stock characteristics (stock by cohort, stock total, stock inflows, stock outflows, ...) and scenario related data. This makes easier to share results and compare results between scenarios.

** Settings file **
User can now introduce metadata columns to settings file that can be skipped when reading the data. This makes easier to keep comments, metadata or some other relevant data closer to the data definition.

Data checking is now more robust and gives meaningful and easy-to-understand errors.
Some options in Sankey graphs are disabled for this version (hiding small nodes, toggling on/off virtual nodes).

aiphoria v0.4

• DataChecker now properly uses data from defined year range
• Added two optional boolean parameters: fill_missing_absolute_flows and fill_missing_relative_flows. If parameter is set to True, then DataChecker fills the missing data depending on the flow unit type. Both parameters are set to True if parameters are not found inside settings file.