Package: amirispy
AMIRIS-PyPython tools for the electricity market modelAMIRIS.Installationpip install amirispyYou may also usepipx. For detailed information please refer to the officialpipxdocumentation.pipx install amirispyFurther RequirementsIn order to execute all commands provided byamirispy, you also require a Java Development Kit (JDK).
JDK must be installed and accessible via your console in which you runamirispy.To test, runjava --versionwhich should show your JDK version (required: 8 or above).
Ifjavacommand is not found or relates to a Java Runtime Environment (JRE), please download and install JDK (e.g. fromAdoptium)UsageCurrently, there are three distinct commands available:amiris install: installation of thelatest AMIRIS versionandexamplesto your computeramiris run: perform a full workflow by compiling the.pbfile from yourscenario.yaml, executing AMIRIS, and converting resultsamiris batch: perform multiple runs each with scenario compilation, AMIRIS execution, and results extractionamiris comparison: compare the results of two different AMIRIS runs to check them for their equivalenceamiris installDownloads and installs the latest open access AMIRIS instance and accompanying examples.OptionAction-uor--urlURL to download AMIRIS from (default: latest AMIRIS artifact fromhttps://gitlab.com/dlr-ve/esy/amiris/amiris-tor--targetFolder to installamiris-core_<version>-jar-with-dependencies.jarto (default:./)-for--forceForce install which may overwrites existing AMIRIS installation of same version and existing examples (default: False)-mor--modeOption to install model and examplesall(default), onlymodel, or onlyexamplesamiris runCompile scenario, execute AMIRIS, and extract results.OptionAction-jor--jarPath toamiris-core_<version>-jar-with-dependencies.jar-sor--scenarioPath to a scenario yaml-file-oor--outputDirectory to write output toamiris batchPerform multiple runs - each with scenario compilation, AMIRIS execution, and results extractionOptionAction-jor--jarPath toamiris-core_<version>-jar-with-dependencies.jar-sor--scenariosPath to single or list of: scenario yaml-files or their enclosing directories-oor--outputDirectory to write output to-ror--recursiveOption to recursively search in provided Path for scenario (default: False)-por--patternOptional name pattern that scenario files searched for must matchamiris compareCompare if results of two AMIRIS runs and equivalent.OptionAction-eor--expectedPath to folder with expected result .csv files-tor--testPath to folder with results files (.csv) to test  for equivalence-ior--ignoreOptional list of file names not to be comparedHelpYou reach the help menu at any point using-hor--helpwhich gives you a list of all available options, e.g.:amiris --helpLoggingYou may define a logging level or optional log file asfirstarguments in your workflow using any of the following arguments:OptionAction-lor--logSets the logging level. Default iserror. Options aredebug,info,warning,warn,error,critical.-lfor--logfileSets the logging file. Default isNone. IfNoneis provided, all logs get only printed to the console.Example:amiris --log debug --logfile my/log/file.txt installCite AMIRIS-PyIf 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.05041ContributingPlease seeCONTRIBUTING.Available SupportThis 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 theopenMod-Forumor viaamiris@dlr.de.
Please report bugs and make feature requests by filing issues following the provided templates (see alsoCONTRIBUTING).
For substantial enhancements, we recommend that you contact us viaamiris@dlr.defor working together on the code in common projects or towards common publications and thus further develop AMIRIS.