Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs to make regime optional #359

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update docs to make regime optional #359

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/gsp.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -241,15 +241,16 @@ def get_truths_for_all_gsps(
Setting the _regime_ parameter to _day-after_ includes
the previous day's truth values for the GSPs.

If _regime_ is not specified, the parameter defaults to _in-day_.
If _regime_ is not specified, the parameter defaults to None and returns PV Live Updated
values where available, falling back to available PV Live Estimated values.

If _compact_ is set to true, the response will be a list of GSPGenerations objects.
This return object is significantly smaller, but less readable.

#### Parameters
- **regime**: can choose __in-day__ or __day-after__
- **start_datetime_utc**: optional start datetime for the query.
- **end_datetime_utc**: optional end datetime for the query.
- **regime**: (optional) can choose __in-day__ or __day-after__
- **start_datetime_utc**: (optional) start datetime for the query.
- **end_datetime_utc**: (optional) end datetime for the query.
"""
logger.info(f"Get PV Live estimates values for all gsp id and regime {regime} for user {user}")

Expand Down
Loading