Skip to content

Latest commit

 

History

History
41 lines (27 loc) · 1.64 KB

README.md

File metadata and controls

41 lines (27 loc) · 1.64 KB

UIUC energy model project

A model detailing the energy systems mix employed at UIUC will be simulated using osier. Single and multiple objective scenarios will be used. Model will be used to write an abstract for the ANS conference. osier was developed by Sam Dotson

Installation of necessary packages

Installation of osier via PyPI

osier can be downloaded through PyPI. It can be downloaded by running the following command in the terminal:

python -m pip install osier

Installation of osier via forking

Additionally, the associated github repository can be forked and built using the terminal. The following commands can be used to fork and build using the terminal:

git clone https://github.com/arfc/osier.git
cd osier
# for a basic installation
pip install .
# (Windows/Linux) to also install the documentation dependencies
pip install .[doc]
# (MacOS)
pip install .'[doc]'

It is recommended to build a conda environment with osier installed using Conda/Mamba. After cloning, one can run:

mamba env create  # mamba and conda are interchangeable, here
mamba activate osier-new 

Installation of CPLEX

This model directly uses the IBM ILOG CPLEX optimization tool for simulations. The steps for installation are available on the CPLEX payment page upon payment. However, the tool itself is free for all verified academic institutions. Steps to install the academic version are here