raphaelsaavedra / SIIPExamples.jl

Examples of how to use the modeling capabilities developed under the Scalable Integrated Infrastructure Planning Initiative at NREL.

Home Page:https://www.nrel.gov/analysis/siip.html

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

SIIPExamples.jl Binder Build Status

This repository contains examples and tutorials for Scalable Integrated Infrastructure Planning (SIIP) packages developed at the National Renewable Energy Laboratory (NREL). This repository uses a template established by JuMPTutorials.jl.

The examples in this repository are intended as practical examples of using SIIP packages. However, in many cases users may find the documentation pages for each package more informative:

Run Notebooks in the Browser

Binder

To try out any of the tutorials in the browser without downloading Julia, click on the launch binder button above. Note that this functionality only supports open-source solvers which do not have additional requirements (for e.g. BLAS or MATLAB). This is also very slow and can take several minutes to start as it has to first install Julia and all the dependencies. Thus, you should download and run the notebooks on your local machine for the best experience.

Run Notebooks on your local computer

Prerequisites:

  • Install Julia
  • Download and extract or clone (via git) the code in this repository

To get started running the Jupyter notebooks included in this repository, you can follow the process in this video demonstrating the following steps:

  1. Install IJulia: using Pkg; Pkg.add("IJulia")
  2. Instantiate the SIIPExamples.jl environment (note: this can take 30+ minutes the first time you run): Pkg.activate("path/to/SIIPExamples.jl/."); Pkg.instantiate()
  3. Launch a notebook server: using IJulia; notebook(dir = "path/to/SIIPExamples/notebook")

Table of Contents

About

Examples of how to use the modeling capabilities developed under the Scalable Integrated Infrastructure Planning Initiative at NREL.

https://www.nrel.gov/analysis/siip.html

License:BSD 3-Clause "New" or "Revised" License


Languages

Language:Jupyter Notebook 92.7%Language:Julia 6.7%Language:Roff 0.6%