Merge pull request #333 from NREL-Sienna/jd/doc_fixes

use case builder in quick start guide
NREL-Sienna · Jun 28, 2023 · 3029649 · 3029649
2 parents 723dbc3 + 30157b2
commit 3029649
Show file tree

Hide file tree

Showing 21 changed files with 149 additions and 387 deletions.
diff --git a/README.md b/README.md
@@ -22,8 +22,8 @@ Check the [Project Section](https://github.com/NREL-Sienna/PowerSimulationsDynam
 
 ```julia
 julia> ]
-(v1.8) pkg> add PowerSystems
-(v1.8) pkg> add PowerSimulationsDynamics
+(v1.9) pkg> add PowerSystems
+(v1.9) pkg> add PowerSimulationsDynamics
 ```
 
 ## Usage
@@ -35,11 +35,24 @@ using PowerSimulationsDynamics
 using PowerSystems
 ```
 
+## References
+
+The background work on `PowerSimulationsDynamics.jl` is explained in [Revisiting Power Systems Time-domain Simulation Methods and Models](https://arxiv.org/pdf/2301.10043.pdf)
+
+```bibtex
+   @article{lara2023revisiting,
+  title={Revisiting Power Systems Time-domain Simulation Methods and Models},
+  author={Lara, Jose Daniel and Henriquez-Auba, Rodrigo and Ramasubramanian, Deepak and Dhople, Sairaj and Callaway, Duncan S and Sanders, Seth},
+  journal={arXiv preprint arXiv:2301.10043},
+  year={2023}
+}
+```
+
 ## Development
 
-Contributions to the development and enahancement of PowerSimulationsDynamics is welcome. Please see [CONTRIBUTING.md](https://github.com/nrel-sienna/PowerSimulationsDynamics.jl/blob/main/CONTRIBUTING.md) for code contribution guidelines.
+Contributions to the development and enahancement of PowerSimulationsDynamics.jl is welcome. Please see [CONTRIBUTING.md](https://github.com/nrel-sienna/PowerSimulationsDynamics.jl/blob/main/CONTRIBUTING.md) for code contribution guidelines.
 
 ## License
 
-PowerSimulationsDynamics is released under a BSD [license](https://github.com/NREL-Sienna/PowerSimulationsDynamics.jl/blob/main/LICENSE).
-PowerSimulationsDynamics has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy Laboratory ([NREL](https://www.nrel.gov/))
+PowerSimulationsDynamics.jl is released under a BSD [license](https://github.com/NREL-Sienna/PowerSimulationsDynamics.jl/blob/main/LICENSE).
+PowerSimulationsDynamics.jl has been developed as part of the Scalable Integrated Infrastructure Planning (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy Laboratory ([NREL](https://www.nrel.gov/))
diff --git a/docs/make.jl b/docs/make.jl
@@ -11,8 +11,8 @@ makedocs(;
         "Tutorials" => Any[
             "Create Dynamic Data" => "tutorials/tutorial_dynamic_data.md",
             "OMIB" => "tutorials/tutorial_omib.md",
-            "Dynamic Lines simulation" => "tutorials/tutorial_dynamic_lines.md",
-            "Inverter modeling" => "tutorials/tutorial_inverter_modeling.md",
+            "Dynamic Lines Simulation" => "tutorials/tutorial_dynamic_lines.md",
+            "Inverter Modeling" => "tutorials/tutorial_inverter_modeling.md",
             "240 WECC solver comparison" => "tutorials/tutorial_240bus.md",
         ],
         "Models" => "models.md",

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -1,7 +1,7 @@
 # PowerSimulationsDynamics.jl
 
 ```@meta
-CurrentModule = PowerSystems
+CurrentModule = PowerSimulationsDynamics
 ```
 
 ## Overview
@@ -16,9 +16,20 @@ Inverter models support both commercial models, such as REPC, REEC and REGC type
 from grid-following and grid-forming literature such as in ["A Virtual Synchronous Machine implementation for
 distributed control of power converters in SmartGrids"](https://www.sciencedirect.com/science/article/pii/S0378779615000024)
 
+The background work on `PowerSimulationsDynamics.jl` is explained in [Revisiting Power Systems Time-domain Simulation Methods and Models](https://arxiv.org/pdf/2301.10043.pdf)
+
+```bibtex
+@article{lara2023revisiting,
+title={Revisiting Power Systems Time-domain Simulation Methods and Models},
+author={Lara, Jose Daniel and Henriquez-Auba, Rodrigo and Ramasubramanian, Deepak and Dhople, Sairaj and Callaway, Duncan S and Sanders, Seth},
+journal={arXiv preprint arXiv:2301.10043},
+year={2023}
+}
+```
+
 ## Installation
 
-The latest stable release of PowerSimulationsDynamics can be installed using the Julia package manager with
+The latest stable release of PowerSimulationsDynamics.jl can be installed using the Julia package manager with
 
 ```julia
 ] add PowerSimulationsDynamics
@@ -38,14 +49,13 @@ all self-contained and return the model function evaluations. The Jacobian is ca
 using automatic differentiation through `ForwardDiff.jl`, that is used for both numerical
 integration and small signal analysis. Considering that the resulting models are differential-algebraic
 equations (DAE), the implementation focuses on the use of implicit solvers, in particular
-BDF and Rosenbrock methods since it has exceptional features applicable to large models — for instance,
-interfacing with distributed linear-solvers and GPU arrays.
+BDF and Rosenbrock methods.
 
 ```@raw html
 <img src="./assets/SoftwareLoop.jpg" width="65%"/>
 ``` ⠀
 
 ------------
-PowerSimulationsDynamics has been developed as part of the Scalable Integrated Infrastructure Planning
+PowerSimulationsDynamics.jl has been developed as part of the Scalable Integrated Infrastructure Planning
 (SIIP) initiative at the U.S. Department of Energy's National Renewable Energy
 Laboratory ([NREL](https://www.nrel.gov/))
diff --git a/docs/src/quick_start_guide.md b/docs/src/quick_start_guide.md
@@ -1,24 +1,23 @@
 # Quick Start Guide
 
-You can access example data in the [Power Systems Test Data Repository](https://github.com/nrel-sienna/PowerSystemsTestData),
-the data can be downloaded with the `PowerSystems.jl` submodule `UtilsData`. Some systems are already provided in [PowerSystemCaseBuilder](https://github.com/nrel-sienna/PowerSystemCaseBuilder.jl).
+The data for these tutorials is provided in [PowerSystemCaseBuilder](https://github.com/nrel-sienna/PowerSystemCaseBuilder.jl). If you want to build your own case, take a look at the tutorial [Creating and Handling Data for Dynamic Simulations](@ref)
+
+For more details about loading data and adding more dynamic components check the
+[Creating a System with Dynamic devices](https://nrel-sienna.github.io/PowerSystems.jl/stable/modeler_guide/system_dynamic_data/)
+section of the documentation in `PowerSystems.jl`.
 
 ## Loading data
 
 Data can be loaded from a pss/e raw file and a pss/e dyr file.
 
 ```@repl quick_start_guide
-using PowerSystems, PowerSimulationsDynamics, PowerSystemCaseBuilder, Sundials, Plots, Logging
-logger = configure_logging(console_level = Logging.Error, file_level = Logging.Info)
-omib_sys = PowerSystemCaseBuilder.build_system(
-                PowerSystemCaseBuilder.PSSETestSystems,
-                "psse_OMIB_sys",
-                )
-```
+using PowerSystems
+using PowerSimulationsDynamics
+using PowerSystemCaseBuilder
+using Sundials
 
-For more details about loading data and adding more dynamic components check the
-[Creating a System with Dynamic devices](https://nrel-sienna.github.io/PowerSystems.jl/stable/modeler_guide/system_dynamic_data/)
-section of the documentation in `PowerSystems.jl`.
+omib_sys = build_system(PSIDTestSystems, "psid_test_omib")
+```
 
 ## Define the Simulation
 

diff --git a/docs/src/tutorials/data/14bus.raw b/docs/src/tutorials/data/14bus.raw
diff --git a/docs/src/tutorials/data/OMIB.raw b/docs/src/tutorials/data/OMIB.raw
diff --git a/docs/src/tutorials/data/ThreeBusInverter.raw b/docs/src/tutorials/data/ThreeBusInverter.raw