Annular

fair-software.eu recommendations
(1/5) code repository
(2/5) license
(3/5) community registry
(4/5) citation
(5/5) checklist
Other best practices
Software Version
Supported Python versions
Continuous Integration
Documentation

Introduction

Annular is a setup for running coupled energy system models with the aim of modeling flexibility scheduling and the policy regulations that affect the behavior of flexibility providers.

Documentation can be found at annular.readthedocs.io.

Name

Why the name 'annular'?

'Annular' means 'in the shape of a ring', with which we specifically think of the rings of Saturn, containing many moons or in other words satellites, just like the satellite models interacting with the central market model.

Installation

You can install annular directly from PyPI:

# Best practice: install in a virtual environment
python3 -m venv .venv
source .venv/bin/activate  # Use `source .venv/Scripts/activate` on Windows

python3 -m pip install annular

Then you can use annular on the command line to run coupled simulations specified by config files.

annular run examples/data/energy_model_coupling.ymmsl

Result files will appear in a results/<CONFIG_FILE_NAME>/ folder, where <CONFIG_FILE_NAME> is the name of the given configuration file.

See the built-in help for further details:

$ annular run --help
usage: annular run [-h] [--verbose] [-o OUTPUT] config_files [config_files ...]

positional arguments:
  config_files         Configuration files to run simulations for.

options:
  -h, --help           show this help message and exit
  --verbose, -v        Controls the level of verbosity in the logging output: -v for INFO, -vv for DEBUG
  -o, --output OUTPUT  Output directory

See the documentation for further explanation and examples.

Contributing

If you want to contribute to the development of annular, have a look at the contribution guidelines.

Further instructions can be found inREADME.dev.md

Citation

For citation information, see CITATION.cff

Credits

This package was created with Cookiecutter and the NLeSC/python-template.