Skip to content

Commit

Permalink
update doc
Browse files Browse the repository at this point in the history
  • Loading branch information
BDonnot committed Jun 2, 2023
1 parent badc8ae commit 18a8f3b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion chronix2grid/generation/renewable/generate_solar_wind.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,17 @@ def main(scenario_destination_path, seed, params, prods_charac, solar_pattern,
solar_pattern (pandas.DataFrame): hourly solar production pattern for a year. It represent specificity of the production region considered
smoothdist (float): parameter for smoothing
write_results (boolean): whether to write results or not. Default is True
return_ref_curve (bool): whether to return the reference curve or not.
return_prng (bool): whether to return (or not) the pseudo random number generator used.
Returns
-------
pandas.DataFrame: solar production chronics generated at every node with additional gaussian noise
pandas.DataFrame: solar production chronics forecasted for the scenario without additional gaussian noise
pandas.DataFrame: wind production chronics generated at every node with additional gaussian noise
pandas.DataFrame: wind production chronics forecasted for the scenario without additional gaussian noise
And a few other arguments depending on the flags (*eg* return_ref_curve or return_prng)
"""

prng = default_rng(seed)
Expand Down

0 comments on commit 18a8f3b

Please sign in to comment.