amirispy 3.3.2

Python tools for the open electricity market model AMIRIS

AMIRIS-Py

Python tools for the electricity market model AMIRIS.

Installation

pip install amirispy

You may also use pipx. For detailed information please refer to the official pipx documentation.

pipx install amirispy

Further Requirements

In order to execute all commands provided by amirispy, you also require a Java Development Kit (JDK). JDK must be installed and accessible via your console in which you run amirispy.

To test, run java --version which should show your JDK version (required: 11 or above). If java command is not found or relates to a Java Runtime Environment (JRE), please download and install JDK (e.g. from Adoptium)

Usage

Currently, there are three distinct commands available:

• amiris download: download the latest versions of AMIRIS and examples files
• amiris run: perform a full workflow by compiling the .pb file from your scenario.yaml, executing AMIRIS, and extracting the results
• amiris batch: perform multiple runs, each with scenario compilation, AMIRIS execution, and results extraction
• amiris comparison: compare the results of two different AMIRIS runs to check their equivalence

You may also use the arguments as a list of strings in your script directly, e.g.

from amirispy.scripts import amiris_cli

amiris_cli(["download", "-m", "model"])

amiris download

Downloads and extracts the latest open access AMIRIS instance and accompanying examples.

Option	Provides
-u or --url	URL to download AMIRIS from (default: latest AMIRIS artifact from https://gitlab.com/dlr-ve/esy/amiris/amiris
-t or --target	Folder to download amiris-core_<version>-jar-with-dependencies.jar to (default: ./)
-f or --force	Force download which may overwrites existing AMIRIS installation of same version and existing examples (default: False)
-m or --mode	Option to download model and examples all (default), only model, or only examples

amiris run

Compile scenario, execute AMIRIS, and extract results.

Option	Provides
-s or --scenario	Path to a scenario yaml-file
-j or --jar	Path to amiris-core_<version>-jar-with-dependencies.jar, defaults to a single "amiris*.jar"-file in current working directory
-o or --output	Directory to write output to, defaults to "./result"
-oo or --output-options	Optional arguments to override default output conversion arguments of fameio
-nc or --no-checks	Skip checks for Java installation and correct version to increase speed

Bug in argparse

:warning: If you provide but a single flag to --output-option, you may get a crash as there is a bug in the argparse library which will not be fixed. We recommend these workarounds:

• provide additional parameters, e.g. for the log level: change -oo "-m" to -oo "-m -l critical", or
• add a space after the single flag: change -oo "-m" to -oo "-m "

Calling AMIRIS from your own script using amiris_cli

If you happen to run AMIRIS in your own script by importing amiris_cli, this is an example of how to use it.

from amirispy.scripts import amiris_cli

commands = [
    "-l", "critical",
    "run",
    "-j", "amiris-core_3.4.0-jar-with-dependencies.jar",
    "-s", "examples/Germany2019/scenario.yaml",
    "-oo", "-m ",
]

amiris_cli(commands)

:warning: Similar to the command-line call you need to work around the argparse bug when using --output-option with a single flag only. Thus, the extra space in statement "-oo", "-m " is intended - see explanation above.

amiris batch

Perform multiple runs - each with scenario compilation, AMIRIS execution, and results extraction

Option	Provides
-s or --scenarios	Path to single or list of: scenario yaml-files or their enclosing directories
-j or --jar	Path to amiris-core_<version>-jar-with-dependencies.jar, defaults to a single "amiris*.jar"-file in current working directory
-o or --output	Directory to write output to "./result"
-r or --recursive	Option to recursively search in provided Path for scenario (default: False)
-p or --pattern	Optional name pattern that scenario files searched for must match
-oo or --output-options	Optional arguments to override default output conversion arguments of fameio
-nc or --no-checks	Skip checks for Java installation and correct version to increase speed

See description of amiris run for details on the issues with the -oo option.

amiris compare

Compare if results of two AMIRIS runs and equivalent.

Option	Provides
-e or --expected	Path to folder with expected result .csv files
-t or --test	Path to folder with results files (.csv) to test for equivalence
-i or --ignore	Optional list of file names not to be compared

Help

You reach the help menu at any point using -h or --help which gives you a list of all available options, e.g.:

amiris --help

Logging

You may define a logging level or optional log file as first arguments in your workflow using any of the following arguments:

Option	Provides
-l or --log	logging level, defaults to error; options are debug, info, warning, warn, error, critical.
-lf or --logfile	path to log file, defaults to None; if None is provided, all logs get only printed to the console.

Example: amiris --log debug --logfile my/log/file.txt download

Cite AMIRIS-Py

If you use AMIRIS-Py for academic work, please cite:

Christoph Schimeczek, Kristina Nienhaus, Ulrich Frey, Evelyn Sperber, Seyedfarzad Sarfarazi, Felix Nitsch, Johannes Kochems & A. Achraf El Ghazi (2023). AMIRIS: Agent-based Market model for the Investigation of Renewable and Integrated energy Systems. Journal of Open Source Software. doi: 10.21105/joss.05041

Contributing

Please see CONTRIBUTING.

Available Support

This is a purely scientific project by (at the moment) one research group. Thus, there is no paid technical support available.

If you experience any trouble with AMIRIS, you may contact the developers at the openMod-Forum or via [e-mail]. Please report bugs and make feature requests by filing issues following the provided templates (see also CONTRIBUTING). For substantial enhancements, we recommend that you contact us via [e-mail] for working together on the code in common projects or towards common publications and thus further develop AMIRIS.

Acknowledgement

Work on AMIRIS-Py was financed by the Helmholtz Association's Energy System Design research programme.