<!-- SPDX-FileCopyrightText: 2024 German Aerospace Center <amiris@dlr.de>
SPDX-License-Identifier: Apache-2.0 -->
[](https://badge.fury.io/py/amirispy)
[](https://badge.fury.io/py/amirispy)
[](https://gitlab.com/dlr-ve/esy/amiris/amiris-py/commits/main)
# AMIRIS-Py
Python tools for the electricity market model [AMIRIS](https://dlr-ve.gitlab.io/esy/amiris/home/).
## Installation
pip install amirispy
You may also use `pipx`. For detailed information please refer to the
official `pipx` [documentation](https://github.com/pypa/pipx).
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](https://adoptium.net/de/temurin/releases/?version=17))
## Usage
Currently, there are three distinct commands available:
- `amiris install`: installation of the [latest AMIRIS version](https://gitlab.com/dlr-ve/esy/amiris/amiris)
and [examples](https://gitlab.com/dlr-ve/esy/amiris/examples) to your computer
- `amiris run`: perform a full workflow by compiling the `.pb` file from your `scenario.yaml`, executing AMIRIS, and
converting 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 them for their equivalence
You may also use the arguments as a list of strings in your script directly, e.g.
```python
from amirispy.scripts import amiris_cli
amiris_cli(["install", "-m", "model"])
```
### `amiris install`
Downloads and installs the latest open access AMIRIS instance and accompanying examples.
| Option | Action |
|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `-u` or `--url` | URL to download AMIRIS from (default: latest AMIRIS artifact from [https://gitlab.com/dlr-ve/esy/amiris/amiris](https://gitlab.com/dlr-ve/esy/amiris/amiris) |
| `-t` or `--target` | Folder to install `amiris-core_<version>-jar-with-dependencies.jar` to (default: `./`) |
| `-f` or `--force` | Force install which may overwrites existing AMIRIS installation of same version and existing examples (default: False) |
| `-m` or `--mode` | Option to install model and examples `all` (default), only `model`, or only `examples` |
### `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 a scenario yaml-file |
| `-o` or `--output` | Directory to write output to, defaults to "./results" |
| `-oo` or `--output-options` | Optional arguments to override default output [conversion arguments of fameio](https://gitlab.com/fame-framework/fame-io/-/blob/main/README.md#read-fame-results) |
| `-nc` or `--no-checks` | Skip checks for Java installation and correct version to increase speed |
### `amiris batch`
Perform multiple runs - each with scenario compilation, AMIRIS execution, and results extraction
| Option | Action |
|------------------------|-------------------------------------------------------------------------------|
| `-j` or `--jar` | Path to `amiris-core_<version>-jar-with-dependencies.jar` |
| `-s` or `--scenarios` | Path to single or list of: scenario yaml-files or their enclosing directories |
| `-o` or `--output` | Directory to write output to |
| `-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 |
| `-nc` or `--no-checks` | Skip checks for Java installation and correct version to increase speed |
### `amiris compare`
Compare if results of two AMIRIS runs and equivalent.
| Option | Action |
|----------------------|-------------------------------------------------------------------|
| `-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 | 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`
## 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](https://doi.org/10.21105/joss.05041)
## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md).
## 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](https://forum.openmod.org/tag/amiris) or via [amiris@dlr.de](mailto:amiris@dlr.de).
Please report bugs and make feature requests by filing issues following the provided templates (see
also [CONTRIBUTING](CONTRIBUTING.md)).
For substantial enhancements, we recommend that you contact us via [amiris@dlr.de](mailto:amiris@dlr.de) 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.
Raw data
{
"_id": null,
"home_page": "https://dlr-ve.gitlab.io/esy/amiris/home/",
"name": "amirispy",
"maintainer": "Christoph Schimeczek",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "amiris@dlr.de",
"keywords": "AMIRIS, agent-based modelling, electricity market",
"author": "Christoph Schimeczek",
"author_email": "amiris@dlr.de",
"download_url": "https://files.pythonhosted.org/packages/67/69/8d31a38a0690d9d37227657c64ce8623a89fca7b8edda7e83088134fbe3f/amirispy-3.0.0.tar.gz",
"platform": null,
"description": "<!-- SPDX-FileCopyrightText: 2024 German Aerospace Center <amiris@dlr.de>\n\nSPDX-License-Identifier: Apache-2.0 -->\n\n[](https://badge.fury.io/py/amirispy)\n[](https://badge.fury.io/py/amirispy)\n[](https://gitlab.com/dlr-ve/esy/amiris/amiris-py/commits/main)\n\n\n# AMIRIS-Py\nPython tools for the electricity market model [AMIRIS](https://dlr-ve.gitlab.io/esy/amiris/home/).\n\n## Installation\n\n pip install amirispy\n\nYou may also use `pipx`. For detailed information please refer to the\nofficial `pipx` [documentation](https://github.com/pypa/pipx).\n\n pipx install amirispy\n\n\n### Further Requirements\n\nIn order to execute all commands provided by `amirispy`, you also require a Java Development Kit (JDK).\nJDK must be installed and accessible via your console in which you run `amirispy`.\n\nTo test, run `java --version` which should show your JDK version (required: 11 or above).\nIf `java` command is not found or relates to a Java Runtime Environment (JRE), please download and install JDK (e.g.\nfrom [Adoptium](https://adoptium.net/de/temurin/releases/?version=17))\n\n## Usage\nCurrently, there are three distinct commands available:\n\n- `amiris install`: installation of the [latest AMIRIS version](https://gitlab.com/dlr-ve/esy/amiris/amiris)\n and [examples](https://gitlab.com/dlr-ve/esy/amiris/examples) to your computer\n- `amiris run`: perform a full workflow by compiling the `.pb` file from your `scenario.yaml`, executing AMIRIS, and\n converting results\n- `amiris batch`: perform multiple runs each with scenario compilation, AMIRIS execution, and results extraction\n- `amiris comparison`: compare the results of two different AMIRIS runs to check them for their equivalence\n\nYou may also use the arguments as a list of strings in your script directly, e.g.\n\n```python\nfrom amirispy.scripts import amiris_cli\n\namiris_cli([\"install\", \"-m\", \"model\"])\n```\n\n### `amiris install`\nDownloads and installs the latest open access AMIRIS instance and accompanying examples.\n\n| Option | Action |\n|--------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `-u` or `--url` | URL to download AMIRIS from (default: latest AMIRIS artifact from [https://gitlab.com/dlr-ve/esy/amiris/amiris](https://gitlab.com/dlr-ve/esy/amiris/amiris) |\n| `-t` or `--target` | Folder to install `amiris-core_<version>-jar-with-dependencies.jar` to (default: `./`) |\n| `-f` or `--force` | Force install which may overwrites existing AMIRIS installation of same version and existing examples (default: False) |\n| `-m` or `--mode` | Option to install model and examples `all` (default), only `model`, or only `examples` |\n\n### `amiris run`\nCompile scenario, execute AMIRIS, and extract results.\n\n| Option | Action |\n|-----------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `-j` or `--jar` | Path to `amiris-core_<version>-jar-with-dependencies.jar` |\n| `-s` or `--scenario` | Path to a scenario yaml-file |\n| `-o` or `--output` | Directory to write output to, defaults to \"./results\" |\n| `-oo` or `--output-options` | Optional arguments to override default output [conversion arguments of fameio](https://gitlab.com/fame-framework/fame-io/-/blob/main/README.md#read-fame-results) |\n| `-nc` or `--no-checks` | Skip checks for Java installation and correct version to increase speed |\n\n### `amiris batch`\nPerform multiple runs - each with scenario compilation, AMIRIS execution, and results extraction\n\n| Option | Action |\n|------------------------|-------------------------------------------------------------------------------|\n| `-j` or `--jar` | Path to `amiris-core_<version>-jar-with-dependencies.jar` |\n| `-s` or `--scenarios` | Path to single or list of: scenario yaml-files or their enclosing directories |\n| `-o` or `--output` | Directory to write output to |\n| `-r` or `--recursive` | Option to recursively search in provided Path for scenario (default: False) |\n| `-p` or `--pattern` | Optional name pattern that scenario files searched for must match |\n| `-nc` or `--no-checks` | Skip checks for Java installation and correct version to increase speed |\n\n### `amiris compare`\nCompare if results of two AMIRIS runs and equivalent.\n\n| Option | Action |\n|----------------------|-------------------------------------------------------------------|\n| `-e` or `--expected` | Path to folder with expected result .csv files |\n| `-t` or `--test` | Path to folder with results files (.csv) to test for equivalence |\n| `-i` or `--ignore` | Optional list of file names not to be compared |\n\n\n### Help\nYou reach the help menu at any point using `-h` or `--help` which gives you a list of all available options, e.g.:\n\n`amiris --help`\n\n\n### Logging\nYou may define a logging level or optional log file as **first** arguments in your workflow using any of the following\narguments:\n\n| Option | Action |\n|----------------------|------------------------------------------------------------------------------------------------------------------|\n| `-l` or `--log` | Sets the logging level. Default is `error`. Options are `debug`, `info`, `warning`, `warn`, `error`, `critical`. |\n| `-lf` or `--logfile` | Sets the logging file. Default is `None`. If `None` is provided, all logs get only printed to the console. |\n\nExample: `amiris --log debug --logfile my/log/file.txt install`\n\n## Cite AMIRIS-Py\nIf you use AMIRIS-Py for academic work, please cite:\n\nChristoph Schimeczek, Kristina Nienhaus, Ulrich Frey, Evelyn Sperber, Seyedfarzad Sarfarazi, Felix Nitsch, Johannes\nKochems & A. Achraf El Ghazi (2023). AMIRIS: Agent-based Market model for the Investigation of Renewable and Integrated\nenergy Systems. Journal of Open Source Software. doi: [10.21105/joss.05041](https://doi.org/10.21105/joss.05041)\n\n## Contributing\nPlease see [CONTRIBUTING](CONTRIBUTING.md).\n\n## Available Support\nThis is a purely scientific project by (at the moment) one research group.\nThus, there is no paid technical support available.\n\nIf you experience any trouble with AMIRIS, you may contact the developers at\nthe [openMod-Forum](https://forum.openmod.org/tag/amiris) or via [amiris@dlr.de](mailto:amiris@dlr.de).\nPlease report bugs and make feature requests by filing issues following the provided templates (see\nalso [CONTRIBUTING](CONTRIBUTING.md)).\nFor substantial enhancements, we recommend that you contact us via [amiris@dlr.de](mailto:amiris@dlr.de) for working\ntogether on the code in common projects or towards common publications and thus further develop AMIRIS.\n\n## Acknowledgement\nWork on AMIRIS-Py was financed by the Helmholtz Association's Energy System Design research programme.",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Python tools for the electricity market model AMIRIS",
"version": "3.0.0",
"project_urls": {
"Homepage": "https://dlr-ve.gitlab.io/esy/amiris/home/",
"Repository": "https://gitlab.com/dlr-ve/esy/amiris/amiris-py/"
},
"split_keywords": [
"amiris",
" agent-based modelling",
" electricity market"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "27ff4416cdcdae58a3a56ba8b20d6ef8a1564eaeef52a58ca2e98a2011aa88ed",
"md5": "900362396f4e05c1e805ba8d6e2d8eb1",
"sha256": "d91dc6980ab95713647ee8730e7942aaf767a050b42272910885348b23f2575a"
},
"downloads": -1,
"filename": "amirispy-3.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "900362396f4e05c1e805ba8d6e2d8eb1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 33933,
"upload_time": "2024-12-04T09:29:09",
"upload_time_iso_8601": "2024-12-04T09:29:09.612294Z",
"url": "https://files.pythonhosted.org/packages/27/ff/4416cdcdae58a3a56ba8b20d6ef8a1564eaeef52a58ca2e98a2011aa88ed/amirispy-3.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "67698d31a38a0690d9d37227657c64ce8623a89fca7b8edda7e83088134fbe3f",
"md5": "389404c11c7a0240e210a739967d3f7c",
"sha256": "c4b545890d31d46f1848f1e8dc98dac93993b7c9e888015890786806f0cdb21c"
},
"downloads": -1,
"filename": "amirispy-3.0.0.tar.gz",
"has_sig": false,
"md5_digest": "389404c11c7a0240e210a739967d3f7c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 28768,
"upload_time": "2024-12-04T09:29:11",
"upload_time_iso_8601": "2024-12-04T09:29:11.399137Z",
"url": "https://files.pythonhosted.org/packages/67/69/8d31a38a0690d9d37227657c64ce8623a89fca7b8edda7e83088134fbe3f/amirispy-3.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 09:29:11",
"github": false,
"gitlab": true,
"bitbucket": false,
"codeberg": false,
"gitlab_user": "dlr-ve",
"gitlab_project": "esy",
"lcname": "amirispy"
}
JSON