Skip to content
/ osier Public

Justice oriented energy system optimization framework

License

Notifications You must be signed in to change notification settings

arfc/osier

Folders and files

NameName
Last commit message
Last commit date

Latest commit

da47eba · Mar 12, 2024
Mar 7, 2024
Mar 12, 2024
Mar 12, 2024
Mar 2, 2024
Sep 16, 2022
Feb 29, 2024
Nov 1, 2022
Sep 9, 2022
Feb 29, 2024
Feb 29, 2024

Repository files navigation

osier

/ˈōZHər/
Open source multi-objective energy system framework

Build Status Documentation Status

Installation

osier is available through PyPI. It may be installed with

pip install osier

or by cloning this repository and building from source:

git clone git@github.com:arfc/osier.git  # requires ssh-keys
# or
git clone https://github.com/arfc/osier.git
cd osier
# for a basic installation
pip install .
# to also install the documentation dependencies
pip install .[doc]

# followed by 
pip install pyomo==6.4.1

Note

Although pyomo is a dependency, the current version of pyomo (6.7.1, as of 2/29/24) has a bug that prints erroneous errors during an osier simulation. Therefore, users are recommended to install a specific version of pyomo after the main installation of osier. There is an open issue #50 related to this concern.

Documentation

The documentation for osier can be viewed here. You can also build the docs locally with:

cd osier/docs
make html
cd build/html
# to serve the documentation
python -m http.server

Tests

osier's tests can be run by executing pytest in the top-level directory of osier.

Contributing

Contributions to osier are welcome. For details on how to make bug reports, pull requests, and other information, check the contributing page.

Credits

Some of the documentation infrastructure was inspired by and borrowed from the watts documentation.