Python tools for AMIRIS
Python tools for the electricity market model AMIRIS.
pip install amirispy
You may also use
pipx. For detailed information please refer to the official
pipx install amirispy
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
To test, run
java --version which should show your JDK version (required: 8 or above).
java command is not found or relates to a Java Runtime Environment (JRE), please download and install JDK (e.g. from Adoptium)
Currently, there are three distinct commands available:
amiris install: installation of the latest AMIRIS version to your computer
amiris run: perform a full workflow by compiling the
.pbfile from your
scenario.yaml, executing AMIRIS, and converting results
amiris comparison: compare the results of two different AMIRIS runs to check them for their equivalence
Downloads and installs the latest open access AMIRIS instance.
||URL to download AMIRIS from (default: latest AMIRIS artifact from https://gitlab.com/dlr-ve/esy/amiris/amiris|
||Folder to install
Compile scenario, execute AMIRIS, and extract results.
||Directory to write output to|
Compare if results of two AMIRIS runs and equivalent.
||Path to folder with expected results|
||Path to folder with results to test|
||Optional list of file names to not be compared|
You reach the help menu at any point using
--help which gives you a list of all available options, e.g.:
You may define a logging level or optional log file as first arguments in your workflow using any of the following arguments:
||Sets the logging level. Default is
||Sets the logging file. Default is
amiris --log debug --logfile my/log/file.txt install
Please see CONTRIBUTING.
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 firstname.lastname@example.org. 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 email@example.com for working together on the code in common projects or towards common publications and thus further develop AMIRIS.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.