All user repositories are setup to work according to Gitflow. Following this, your repository will already have two branches from the start,
The repository has an easy to understand structure. Below are the most important parts of the repository:
Copy├── cmd/<model> ├──── data │ ├── input.json ├── cmd.sh ├── main.go ├── <model> │ ├── schema.go │ ├── solver.go ├── version.go
cmd/<model> directory has everything needed to run the model (for example, a
dispatch application). The main entry to run and debug the model is found in the
cmd/<model>/main.go file. The example
input.json is located in the
data sub-directory. You can use this file as a guide to help you set up your own input files.
The model itself consists of two parts:
schema.goloads the relevant data from a given input file.
solver.gouses the data to solve the optimization problem.
version.go states the current app version you are using. This will also be part of your output file by default when generating solutions and allows us to help you quicker if you have questions.