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

Add data dir explanation #16

Merged
merged 4 commits into from
Jun 7, 2024
Merged

Add data dir explanation #16

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d04913f
add data_dir explanation
prakaa Jun 6, 2024
52eb3f4
elaborate on data_dir desc
prakaa Jun 7, 2024
fed96a1
improve readability
prakaa Jun 7, 2024
aa44d4d
merge into one note box
prakaa Jun 7, 2024
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
15 changes: 14 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,20 @@ Simply import `mms_monthly_cli` as follows:
import mms_monthly_cli.mms_monthly as mms_monthly
```

This will expose the following functions (accessed using `mms_monthly.<func_name>`):
This will expose the functions listed below (accessed using `mms_monthly.<func_name>`).

> [!NOTE]
> The `data_dir` argument requires you to specify which folder within `MMSDM_YYYY_MM` you are interested in.
> Most users will be interested in tables within `DATA` (i.e. `data_dir="DATA"`).
>
> You can also access `PREDISP_ALL_DATA` (pre-dispatch data)
> and `P5MIN_ALL_DATA` (5-minute pre-dispatch data). Data tables in the `PREDISP_ALL_DATA` folders
> contain *all* forecasts for an interval of interest, whereas `PREDISPATCH` data tables in the `DATA` folder only contain the latest interval
> (refer to [this part of the NEMSEER docs for more detail](https://nemseer.readthedocs.io/en/latest/quick_start.html#predispatch-tables)).
> It is unclear if the same is true for `P5MIN_ALL_DATA`; `P5MIN` data tables in `DATA` appear have the same data with some minor differences
> (e.g. one column name is different in the constraint files).
>
> If you are accessing pre-dispatch data, consider using [NEMSEER](https://github.com/UNSW-CEEM/NEMSEER).

---
```python
Expand Down
Loading