Skip to main content

Python tools for AMIRIS

Project description

PyPI version PyPI license pipeline status pipeline status

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: 8 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 install: installation of the latest AMIRIS version to your computer
  • amiris run: perform a full workflow by compiling the .pb file 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

amiris install

Downloads and installs the latest open access AMIRIS instance.

Option Action
-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 install amiris-core_<version>-jar-with-dependencies.jar to (default: ./)

amiris run

Compile scenario, execute AMIRIS, and extract results.

Option Action
-j or --jar Path to amiris-core_<version>-jar-with-dependencies.jar
-s or --scenario Path to scenario.yaml
-o or --output Directory to write output to

amiris compare

Compare if results of two AMIRIS runs and equivalent.

Option Action
-e or --expected Path to folder with expected results
-t or --test Path to folder with results to test
-i or --ignore Optional list of file names to not 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 Action
-l or --log Sets the logging level. Default is error. Options are debug, info, warning, warn, error, critical.
-lf or --logfile Sets the logging file. Default is None. If None is provided, all logs get only printed to the console.

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

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 amiris@dlr.de. 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 amiris@dlr.de for working together on the code in common projects or towards common publications and thus further develop AMIRIS.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

amirispy-1.1.1.tar.gz (12.6 kB view hashes)

Uploaded source

Built Distribution

amirispy-1.1.1-py3-none-any.whl (14.6 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page