Tutorial: Run the Model

Start this tutorial after you have completed the Installation.

Table of Contents

• Tutorial for PC and Git
• Tutorial for Docker

Tutorial for PC and Git

Before running the model, check that the following are complete from the installation:

1. Data and Guesses and the RWCode Repository have been downloaded.

2. The Results folder has been created.

3. Julia version is 1.10

4. There are 12+ threads in the Julia session.

Activate and compile the package:

• Navigate to the working directory with the package...

julia> cd("PATH/TO/RWCode")

julia> ]

(@v1.10) pkg> activate .

(RWCode) pkg> instantiate

julia> using RWCode

Set paths for Data, Guesses and Results Folders:

julia> D = "FULL/PATH/TO/DATA"
"FULL/PATH/TO/DATA"

julia> G = "FULL/PATH/TO/Guesses"
"FULL/PATH/TO/Guesses"

julia> R = "FULL/PATH/TO/Results"
"FULL/PATH/TO/Results"

Configure the model (see Model Configuration for more details):

julia> config = ModelConfig()

Run the model:

julia> run_rwcode(config, D, G, R)

Tutorial for Docker

1. There are 12+ threads in the Julia session.

Set up variable paths to data, guesses and results:

julia> D = "/home/jl/Data"

julia> G = "/home/jl/Guesses"

julia> R = "/home/jl/Results"

Configure the model:

julia> config = ModelConfig()
Enter RunTransition (0 or 1, default = 1):

Enter RunBatteries (0 or 1, default=0):

Enter RunExog (0 or 1, default=0):

Enter RunCurtailment (0 or 1, default=0):

Enter the Number of Transition Iterations (recommend 0-100 iterations, default=2):

Enter Initial Production (default = 100):

Enter hoursofstorage (default=0):

Enter hoursvec (comma-separated, default = 2,4,6):

• In this example, all of the values are automatically set to the default. For more information about the model configurations see this page.

Run the model:

julia> run_rwcode(config, D, G, R)

Copy the results from container to local:

• In the terminal/CLI...

docker ps -a	# this command will print the container ID in the first column.
docker cp <containerID>:/home/jl/Results </host/path/target>

• Change </host/path/target> to the local path you want to copy the data into.