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.

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

Tutorials updates #85

Merged
merged 5 commits into from
Oct 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,15 @@ Installation
=============
pvops can be installed using `pip`. See more information at [readthedocs](https://pvops.readthedocs.io/en/latest/).

Tutorials
=========
To get started with pvops we recommended working with the [tutorials](https://pvops.readthedocs.io/en/latest/pages/tutorials.html)


Package Layout and Documentation
==============

The package is delineated into the following directories. Refer to the `tutorials` directory for a full run-through of the available functionality.
The package is delineated into the following directories.
```
├───docs : Documentation directory
|
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/moduleguides/timeseries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ types of expected energy models:
* Linear: a high flexibility linear regression model.

Additionally, the ability to generate expected energy via IEC
standards is implemented in the :py:mod:`~pvops.timeseries.models.iec`
standards (iec 61724-1) is implemented in the :py:mod:`~pvops.timeseries.models.iec`
module.

An example of usage can be found in
Expand Down
3 changes: 2 additions & 1 deletion pvops/timeseries/models/AIT.py
Original file line number Diff line number Diff line change
Expand Up @@ -180,7 +180,8 @@ def predict(self, prod_df, prod_col_dict):
def AIT_calc(prod_df, prod_col_dict):
"""
Calculates expected energy using measured irradiance
based on trained regression model from field data
based on trained regression model from field data.
Plane-of-array irradiance is recommended when using the pre-trained AIT model.

Parameters
----------
Expand Down
6 changes: 3 additions & 3 deletions pvops/timeseries/models/iec.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
def iec_calc(prod_df, prod_col_dict, meta_df, meta_col_dict,
gi_ref=1000.0):
"""Calculates expected energy using measured irradiance
based on IEC calculations
based on IEC calculations.

Parameters
----------
Expand All @@ -21,9 +21,9 @@ def iec_calc(prod_df, prod_col_dict, meta_df, meta_col_dict,
site-ID column name in prod_df
- **timestamp** (*string*), should be assigned to
time-stamp column name in prod_df
- **irradiance** (*string*), should be assigned to
- **irradiance** (*string*), **plane-of-array**. Should be assigned to
irradiance column name in prod_df, where data
should be in [W/m^2]
should be in [W/m^2].
- **baseline** (*string*), should be assigned to
preferred column name to capture IEC calculations
in prod_df
Expand Down
187 changes: 69 additions & 118 deletions tutorials/tutorial_timeseries.ipynb

Large diffs are not rendered by default.

Loading