Installation and usage instructions

Requirements:

• Julia v1.8.5 or later: https://julialang.org/downloads/

Installation of ReSiE:

1. Get a copy: git clone git@github.com:QuaSi-Software/resie.git
2. Switch into project directory: cd /path/to/repo
3. Start the julia REPL with julia
4. Switch to the package REPL with ] (no enter necessary)
5. Activate the project environment: activate .
6. Add required packages: add ColorSchemes Debugger Infiltrator JSON PlotlyJS ResumableFunctions Test
7. Exit out of the package REPL with shortcut Ctrl+c
8. Exit out of the julia REPL with exit()

Usage of ReSiE:

1. Switch into project directory: cd /path/to/resie
2. Run the simulation with julia --project=. src/resie-cli.jl examples/example_two_sector.json
3. Outputs of the example projects can be found in output/out.csv and output/info_dump.md

Usage of ReSiE with VS Code

In Visual Studio Code, you can make configuration in the file .vscode/launch.json that is automatically created when you open the local ReSiE-folder with VS Code. Use the following example configure to run ReSiE directly from VS Code (copy into the launch.json). To run a specific input file, use the configuration "Run ReSiE from defined input file":

{
    "version": "0.2.0",
    "configurations": [

        {
            "name": "Run active Julia file",
            "type": "julia",
            "request": "launch",
            "program": "${file}",
            "stopOnEntry": false,
            "cwd": "${workspaceFolder}",
            "juliaEnv": "${command:activeJuliaEnvironment}",
        },
        {
            "name": "Run ReSiE from defined input file",
            "type": "julia",
            "request": "launch",
            "stopOnEntry": false,
            "program": "path/to/resie/cli/resie-cli.jl",
            "cwd": "path/to/resie/folder/",
            "juliaEnv": "${command:activeJuliaEnvironment}",
            "args" : ["path/to/input_file.json"]
        }
    ]
}