Merge pull request #34 from NREL-Sienna/jm/basic_docs

Add basic documentation and remove empty quick start guide
NREL-Sienna · Nov 22, 2024 · 8e65a64 · 8e65a64
2 parents 22bc892 + 96cf54f
commit 8e65a64
Show file tree

Hide file tree

Showing 4 changed files with 49 additions and 7 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -3,7 +3,6 @@ import OrderedCollections: OrderedDict
 
 pages = OrderedDict(
     "Welcome Page" => "index.md",
-    "Quick Start Guide" => "quick_start_guide.md",
     "Tutorials" => "tutorials/intro_page.md",
     "Public API Reference" => "api/public.md",
     "Internal API Reference" => "api/internal.md",

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,12 +1,56 @@
-# PowerSystems.jl
+# PRASInterface.jl
 
 ```@meta
 CurrentModule = PRASInterface
 ```
 
-## Overview
+## About
 
-`PRASInterface.jl` is a [`Julia`](http://www.julialang.org) package that provides blah blah
+`PRASInterface.jl` is a [`Julia`](http://www.julialang.org) package that provides an interface to [`PRAS.jl`](https://nrel.github.io/PRAS) from [Sienna](https://www.nrel.gov/analysis/sienna.html)'s [`PowerSystem.jl`](https://github.com/NREL-Sienna/PowerSystems.jl)'s `System` data model.
+
+The Probabilistic Resource Adequacy Suite (PRAS) analyzes the resource adequacy of a bulk power system using Monte Carlo methods.
+
+## Getting Started
+
+To use `PRASInterface.jl`, you first need a `System` from `PowerSystems.jl`
+
+### 1. Install
+
+```
+] add PRASInterface
+```
+
+### 2. Add Data
+
+Add outage information to generators using the supplemental attribute [`GeometricDistributionForcedOutage`](https://nrel-sienna.github.io/PowerSystems.jl/stable/api/public/#PowerSystems.GeometricDistributionForcedOutage).
+
+```julia
+using PowerSystems
+transition_data = GeometricDistributionForcedOutage(;
+    mean_time_to_recovery=10,  # Units of hours
+    outage_transition_probability=0.005,  # Probability for outage per hour
+)
+component = get_component(Generator, sys, "test_generator")
+add_supplemental_attribute!(sys, component, transition_data)
+```
+
+### 3. Calculate Shortfalls and Expected Unserved Energy on System
+
+```julia
+using PRASInterface
+method = SequentialMonteCarlo(samples=10_000, seed=1)
+shortfalls, = assess(sys, PowerSystems.Area, sequential_monte_carlo, Shortfall())
+eue = EUE(shortfalls)
+```
+
+## Documentation
+
+  - [PRAS Documentation](https://nrel.github.io/PRAS/)
+
+```@contents
+Pages = ["api/public.md", "tutorials"]
+Depth = 2
+```
 
 * * *
 

diff --git a/docs/src/quick_start_guide.md b/docs/src/quick_start_guide.md
diff --git a/docs/src/tutorials/intro_page.md b/docs/src/tutorials/intro_page.md
@@ -1 +1,3 @@
 # Examples
+
+Tutorials to be created soon.