/STraM

Primary LanguagePythonMIT LicenseMIT

Strategic TRansport Model (STraM)

Open source version of STraM in Pyomo

Licencing

The STraM framework and all additional files in the git repository are licensed under the MIT license. In short, that means you can use and change the code of STraM. Furthermore, you can change the license in your redistribution but must mention the original author. We appreciate if you inform us about changes and send a merge request via git. For further information please read the LICENSE file, which contains the license text, or go to https://opensource.org/licenses/MIT

Required Software

STraM is available in the Python-based, open-source optimization modelling language Pyomo. Running the model thus requires some coding skills in Python. To run the model, make sure Python, Pyomo and a third-party solver (e.g., gurobi, or CPLEX) is installed and loaded to the respective computer. More information on how to install Python and Pyomo can be found here: http://www.pyomo.org/installation. Other python package dependencies can be found in the file requirements.txt.

To download, you need to install Git and clone the repository.

Software Structure

STraM consists of various programming scripts, including:

(1) Main.py: The main script used to run STraM. It links to all other scripts. This is the main script a user needs to use and potentially modify. There are various analyses that can be selected.

(2) Model.py: Contains the model formulation of STraM in Pyomo.

(3) Data/ConstructData.py: this file constructs the necessary data structure based on all excel files.