WIP: Overhaul of the get_components tutorial. #1201
Conversation
| the system and getting both its components and their data. We will also start checking for | ||
| time-series data, which we will explore more in the tutorial on | ||
| [Working with Time Series Data](@ref tutorial_time_series). | ||
| PowerSystems provides functional interfaces to all data. In this tutorial we will explore how to manipulate various static data sets using the `get_component` and `set_*` functions. By the end of this tutorial you will be able to access the data stored in your system and be able to manipulate it. |
There was a problem hiding this comment.
Backticks on PowerSystems and all Sienna names/objects
|
|
||
| In [Create and Explore a Power `System`](@ref), we created a basic `System` with nodes, a transmission | ||
| line, and a few generators. Let's recreate that system if you don't have it already: | ||
| We are going to begin by loading in a test case from the `PowerSystemCaseBuilder`. |
There was a problem hiding this comment.
Add hyperlink to PSCB github or documentation
|
|
||
| ```@repl get_components | ||
| #### Accessing types of data stored in our system | ||
| If we are interested in seeing a certain data type stored in our system, for example the thermal generators, we can call them using the `get_components` function. |
There was a problem hiding this comment.
Hyperlinks on all function names: [`get_components`](@ref)
|
|
||
| The fields within a component can be accessed using the `get_*` functions: |
There was a problem hiding this comment.
Let's add the first part of this comment back in at some point, as a warning admonition. See also https://nrel-sienna.github.io/PowerSystems.jl/stable/explanation/system/#dot_access
| type (concrete or abstract) and the system and it also accepts filter functions for a more | ||
| refined search. The container is optimized for iteration over abstract or concrete component | ||
| types as described by the [Type Structure](@ref type_structure). Given the potential size of the return, | ||
| `PowerSystems.jl` returns Julia iterators in order to avoid unnecessary memory allocations. --> |
There was a problem hiding this comment.
Let's add this last line back in at some point, in a reflection statement about get_components returning an iterator, as a set-up to using collect
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1201 +/- ##
==========================================
- Coverage 84.61% 84.37% -0.24%
==========================================
Files 181 181
Lines 8285 8382 +97
==========================================
+ Hits 7010 7072 +62
- Misses 1275 1310 +35
Flags with carried forward coverage won't be shown. Click here to find out more. |
Overhaul of get_component tutorial.