resiteIP
This file provides the information required to set up the integer programming-based resite tool. At this stage, the IP version is not integrated in the broader resite package.
Setup
This module runs in any 3.x version of Python. The Python packages required to run this module are listed
in the requirements.yml
file included in the repository. Their installation can be easily achieved via the the following
command that builds a separate environment for this module from the yml
file:
conda env create -f environment.yml
The tool requires to installation of an MILP solver. At the time of writing, gurobi
is the only solver this
model supports (see installation details here).
Minimal working example
This structure of this package is as follows:
-
resite_ip
as a container for:- the
src
folder, which includes- the
.py
files taking care of pre- and post-processing - the
jl
folder containing the.jl
routines defining the siting heuristics
- the
- the
config
files - auxiliary files required to set up the package
- the
The data
folder (whose path must be specified in the first line of config_model.yml
) is provided in a different zenodo-like repository. In order to run the model, the following steps must be taken:
- Ensure input data is available according to the structure provided in the
data
folder - Configure run via the
config
files - Run
python main.py
from thesrc
folder
Results of these runs are stored in an output
directory at the same level as the data
folder.
Citing
Please cite the following paper if you use this software in your research.
To be added.
License
This software is released as free software under the GPLv3.