This document describes that you'll need in your local environment to participate in this tutorial.
git clone https://github.com/NREL-SIIP/SIIP-Tutorial.git
git
to clone this repository anywhere you choose.~/gitrepos/SIIP-Tutorial
C:\gitrepos\SIIP-Tutorial
Git Bash
to clone the repository.For the tutorial, we want to install some packages in a isolated, reproducible environment.
This repository contains a Project.toml
and a Manifest.toml
file.
The "environment" defined by these files is all you'll need for this tutorial today.
You can read more about Julia's package manager in the official documentation: https://docs.julialang.org/en/v1/stdlib/Pkg/.
In order to instantiate our environment, we want to run instantiate
in the Package mode in the Julia REPL. Follow the steps below to do this using vscode.
Ctrl
+ Shift
+ P
to open the vscode command palette.Cmd
+ Shift
+ P
to open the vscode command palette.]
to open the Pkg mode.instantiate
and hit enter.status
in the package manager mode to see whether the current environment was instantiated correctly:If you want to do this from your terminal instead, you can run the following from the root of the repository.
julia --project -e "using Pkg; Pkg.instantiate()"
Once you have your environment instantiated correctly you are ready to go.
Alternatively, you can run julia --project
in a terminal from the root directory of this repository.
In vscode, open the command palette and type "Julia: Connect external REPL". You should see a pop up open at the bottom right of your screen.
If you hit the Copy Code button, you can then paste it in a terminal of your choice.