osier: A justice oriented energy system optimization tool
Project description
osier
/ˈōZHər/
Open source multi-objective energy system framework
Installation
osier
is not currently on PyPI or Conda-forge (we hope this will change
soon). It may be installed by executing the following commands on the command
line:
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]
Someday, the osier
documentation will be hosted on its own website. For
now the documentation may be built 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.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.