Add HydroPowerSimulations Docs #51

rodrigomha · 2024-12-24T00:38:23Z

No description provided.

codecov · 2024-12-24T00:51:10Z

Codecov Report

Attention: Patch coverage is 50.00000% with 1 line in your changes missing coverage. Please review.

Project coverage is 79.12%. Comparing base (8dc1711) to head (1a08f6a).
Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
src/feedforwards.jl	0.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #51      +/-   ##
==========================================
- Coverage   81.98%   79.12%   -2.86%     
==========================================
  Files           9        9              
  Lines         877      915      +38     
==========================================
+ Hits          719      724       +5     
- Misses        158      191      +33

Flag	Coverage Δ
unittests	`79.12% <50.00%> (-2.86%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Files with missing lines	Coverage Δ
src/core/constraints.jl	`100.00% <ø> (ø)`
src/core/expressions.jl	`50.00% <ø> (+50.00%)`	⬆️
src/core/formulations.jl	`100.00% <ø> (ø)`
src/core/initial_conditions.jl	`100.00% <ø> (ø)`
src/core/parameters.jl	`46.15% <ø> (ø)`
src/core/variables.jl	`100.00% <ø> (ø)`
src/hydro_generation.jl	`74.83% <100.00%> (+1.22%)`	⬆️
src/hydrogeneration_constructor.jl	`91.38% <ø> (+0.61%)`	⬆️
src/feedforwards.jl	`60.95% <0.00%> (-29.53%)`	⬇️

kdayday

Nice! I've added some comments based to improve formatting -- see best practices on general formatting. I think the extension packages would benefit from using DocumenterInterlinks.jl to other packages. Let me know if you need help. Thanks!

kdayday · 2024-12-24T19:33:29Z

docs/src/index.md

@@ -6,8 +6,8 @@ CurrentModule = HydroPowerSimulations

 ## Overview

-`HydroPowerSimulations.jl` is a [`Julia`](http://www.julialang.org) package that provides blah blah
+`HydroPowerSimulations.jl` is a [`Julia`](http://www.julialang.org) package that extends [`PowerSimulations.jl`](https://github.com/NREL-Sienna/PowerSimulations.jl) for modeling of hydro generation technology in production cost modeling simulations.


Suggested change

`HydroPowerSimulations.jl` is a [`Julia`](http://www.julialang.org) package that extends [`PowerSimulations.jl`](https://github.com/NREL-Sienna/PowerSimulations.jl) for modeling of hydro generation technology in production cost modeling simulations.

`HydroPowerSimulations.jl` is a [`Julia`](http://www.julialang.org) package that extends [`PowerSimulations.jl`](https://nrel-sienna.github.io/PowerSimulations.jl/stable/) for modeling of hydro generation technology in production cost modeling simulations.

production cost modeling simulations -> operational simulations

@rodrigomha, can you update the hyperlink above, too?

Miss that one

kdayday · 2024-12-24T19:40:45Z

docs/src/tutorials/single_stage_model.md

Review the compiled html to remove all errors -- looks like PSCB isn't in the environment, and all code examples are failing

kdayday · 2024-12-24T19:41:10Z

docs/src/tutorials/single_stage_model.md

@@ -0,0 +1,62 @@
+# [Operation Problem with `HydroPowerSimulations.jl`](@id op_problem)
+
+**Originally Contributed by:** Rodrigo Henriquez-Auba


I would remove

kdayday · 2024-12-24T19:42:37Z

docs/src/tutorials/single_stage_model.md

+!!! note
+
+    `PowerSystemCaseBuilder.jl` is a helper library that makes it easier to reproduce examples in the documentation and tutorials. Normally you would pass your local files to create the system data instead of calling the function `build_system`.
+    For more details visit [PowerSystemCaseBuilder Documentation](https://nrel-sienna.github.io/PowerSystems.jl/stable/tutorials/powersystembuilder/)


Link is failing due to PSY re-org. Either update, or preferably, set up DocumenterInterlinks.jl to PSY and use: [PowerSystemCaseBuilder Documentation](@extref powersystembuilder)

kdayday · 2024-12-24T19:45:01Z

docs/src/tutorials/single_stage_model.md

+sys = build_system(PSITestSystems, "c_sys5_hy")
+```
+
+With a single `HydroDispatch`:


Nice job breaking the code up into chunks. Please preface each call to a new function with a hyperlink to its docstring, e.g.,

With a single [`PowerSystems.HydroDispatch`](@extref)

kdayday · 2024-12-24T19:46:46Z

docs/src/tutorials/single_stage_model.md

+
+## Decision Model
+
+Setting up the formulations, including hydro using `HydroDispatchRunOfRiver`


Maybe break this up to clarify what is coming standard from PSI, and reiterating the hydro part is from this extension package?

This one is defined here in HSS. The only formulation from PSI that's not defined here is FixedOutput

kdayday · 2024-12-24T19:47:11Z

docs/src/tutorials/single_stage_model.md

+set_device_model!(template, HydroDispatch, HydroDispatchRunOfRiver)
+```
+
+```@repl op_problem


Needs a text intro with hyperlinks

kdayday · 2024-12-24T19:52:06Z

src/core/expressions.jl

@@ -1,4 +1,12 @@
+"""
+Expression for HydroPumpedStorage that keep track


Please turn this and all following references to HydroPumpedStorage into hyperlinks to the docstring using @extref: http://juliadocs.org/DocumenterInterLinks.jl/stable/

kdayday · 2024-12-24T19:54:31Z

src/feedforwards.jl

-    source - From where the data comes
-    affected_values -
+  - `component_type::Type{<:PSY.Component}` : Specify the type of component on which the Feedforward will be applied
+  - `source::Type{T}` : Specify the VariableType, ParameterType or AuxVariableType as the source of values for the Feedforward


Add hyperlinks for all Types named in args lists

kdayday · 2024-12-24T19:54:43Z

src/hydrogeneration_constructor.jl

@@ -1419,6 +1419,9 @@ function PSI.construct_device!(
    return
 end

+"""
+Construct model for HydroGen with HydroCommitmentRunOfRiver Formulation


jd-lara

This looks good to me. The only needed thing is to address @kdayday's comments

rodrigomha · 2024-12-26T22:38:30Z

Thanks for the comments: Here is the preview with the latest changes: https://nrel-sienna.github.io/HydroPowerSimulations.jl/previews/PR51/

@kdayday I did my best to add as much as possible for refs end extrefs. Hopefully I did not miss anything. I also realized that we do not have docstrings for ActivePowerBalance in PSI, so we will need to add those when we do the PSI docs update.

kdayday

@rodrigomha Looks good, -- I left 2 more comments/suggestions.

This closes #49, #50, correct? And any more updates to #38?

I also just added a new issue #52 to follow up on migrating the formulation library into the api -- please add any feedback there, thanks!

kdayday · 2024-12-30T20:24:01Z

docs/src/tutorials/single_stage_model.md

+res = OptimizationProblemResults(model)
+```
+
+with dispatch variable results for the hydro:


Suggested change

with dispatch variable results for the hydro:

Use [`read_variable`](@ref InfrastructureSystems.Optimization.read_variable) to read in the dispatch variable results for the hydro:

rodrigomha · 2024-12-30T22:12:56Z

@rodrigomha Looks good, -- I left 2 more comments/suggestions.

This closes #49, #50, correct? And any more updates to #38?

I also just added a new issue #52 to follow up on migrating the formulation library into the api -- please add any feedback there, thanks!

I think this should also close #38, and yeah #50. Regarding #49, I'm not sure if this new HydroReservoir, is Pedro's new Reservoir model that we have not implemented yet.

kdayday · 2024-12-31T00:56:08Z

@rodrigomha Looks good, -- I left 2 more comments/suggestions.
This closes #49, #50, correct? And any more updates to #38?
I also just added a new issue #52 to follow up on migrating the formulation library into the api -- please add any feedback there, thanks!

I think this should also close #38, and yeah #50. Regarding #49, I'm not sure if this new HydroReservoir, is Pedro's new Reservoir model that we have not implemented yet.

Sounds good. Can you also update the formatter to close #38? Number 4 here: https://nrel-sienna.github.io/InfrastructureSystems.jl/dev/docs_best_practices/how-to/requirements_checklist/#For-Existing-Packages Thanks!

rodrigomha · 2024-12-31T19:15:53Z

@rodrigomha Looks good, -- I left 2 more comments/suggestions.
This closes #49, #50, correct? And any more updates to #38?
I also just added a new issue #52 to follow up on migrating the formulation library into the api -- please add any feedback there, thanks!

I think this should also close #38, and yeah #50. Regarding #49, I'm not sure if this new HydroReservoir, is Pedro's new Reservoir model that we have not implemented yet.

Sounds good. Can you also update the formatter to close #38? Number 4 here: https://nrel-sienna.github.io/InfrastructureSystems.jl/dev/docs_best_practices/how-to/requirements_checklist/#For-Existing-Packages Thanks!

Thanks Kate. I updated to be like what we have in IS.

rodrigomha added 13 commits December 23, 2024 16:28

update readme

bbb0172

update packages in docs toml

337e3f8

add docstrings for FF

25d1d24

update doscstrings in constructors

bf3df7c

add new exports

946f5bb

update docstrings for expressions

fae3da4

add docstring for IC params and vars

03d0a6a

add formulation page

f7f6642

add quick start guide

f693d47

update api usage

1d79230

complete index page

b6c629a

add tutorial for single step simulation

26f79a6

update make.jl

028742b

rodrigomha requested review from kdayday, jd-lara and kennedy-mindermann December 24, 2024 00:38

rodrigomha self-assigned this Dec 24, 2024

kdayday requested changes Dec 24, 2024

View reviewed changes

kennedy-mindermann linked an issue Dec 24, 2024 that may be closed by this pull request

Initial clean-up and reorganization of HydroPowerSimulations documentation #38

Open

4 tasks

jd-lara requested changes Dec 26, 2024

View reviewed changes

rodrigomha added 9 commits December 26, 2024 14:25

update readme

0e4927d

add PSB and Interlinks to docs TOML

d81d474

add interlinks to make.jl

2d80bc3

export constraints

979e33b

update constraint docstrings

f878352

add links

7ba59f7

add links and false canonical docstring in formulations

35faf03

update links

66f469a

update tutorial docs

5845ab2

add formulations to API

2580b81

update PSI docs link

61e034f

kdayday reviewed Dec 30, 2024

View reviewed changes

update read_variable comment

f446b65

rodrigomha added 2 commits December 31, 2024 11:13

update formatter

9b034f0

new formatting

1a08f6a

kdayday approved these changes Dec 31, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add HydroPowerSimulations Docs #51

Add HydroPowerSimulations Docs #51

rodrigomha commented Dec 24, 2024

codecov bot commented Dec 24, 2024 •

edited

Loading

kdayday left a comment

kdayday Dec 24, 2024

jd-lara Dec 26, 2024

kdayday Dec 30, 2024

rodrigomha Dec 30, 2024

kdayday Dec 24, 2024

kdayday Dec 24, 2024

kdayday Dec 24, 2024

kdayday Dec 24, 2024

kdayday Dec 24, 2024

jd-lara Dec 26, 2024

kdayday Dec 24, 2024

kdayday Dec 24, 2024

kdayday Dec 24, 2024

kdayday Dec 24, 2024

jd-lara left a comment

rodrigomha commented Dec 26, 2024

kdayday left a comment

kdayday Dec 30, 2024

rodrigomha commented Dec 30, 2024 •

edited

Loading

kdayday commented Dec 31, 2024

rodrigomha commented Dec 31, 2024

	`HydroPowerSimulations.jl` is a [`Julia`](http://www.julialang.org) package that extends [`PowerSimulations.jl`](https://github.com/NREL-Sienna/PowerSimulations.jl) for modeling of hydro generation technology in production cost modeling simulations.
	`HydroPowerSimulations.jl` is a [`Julia`](http://www.julialang.org) package that extends [`PowerSimulations.jl`](https://nrel-sienna.github.io/PowerSimulations.jl/stable/) for modeling of hydro generation technology in production cost modeling simulations.

		@@ -0,0 +1,62 @@
		# [Operation Problem with `HydroPowerSimulations.jl`](@id op_problem)

		Originally Contributed by: Rodrigo Henriquez-Auba


		## Decision Model

		Setting up the formulations, including hydro using `HydroDispatchRunOfRiver`

		@@ -1,4 +1,12 @@
		"""
		Expression for HydroPumpedStorage that keep track

	with dispatch variable results for the hydro:
	Use [`read_variable`](@ref InfrastructureSystems.Optimization.read_variable) to read in the dispatch variable results for the hydro:

Add HydroPowerSimulations Docs #51

Are you sure you want to change the base?

Add HydroPowerSimulations Docs #51

Conversation

rodrigomha commented Dec 24, 2024

codecov bot commented Dec 24, 2024 • edited Loading

Codecov Report

kdayday left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jd-lara left a comment

Choose a reason for hiding this comment

rodrigomha commented Dec 26, 2024

kdayday left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rodrigomha commented Dec 30, 2024 • edited Loading

kdayday commented Dec 31, 2024

rodrigomha commented Dec 31, 2024

codecov bot commented Dec 24, 2024 •

edited

Loading

rodrigomha commented Dec 30, 2024 •

edited

Loading