NREL-Sienna / InfrastructureSystems.jl

Utility package for Sienna's simulation infrastructure
https://nrel-sienna.github.io/InfrastructureSystems.jl/
BSD 3-Clause "New" or "Revised" License
35 stars 20 forks source link

Time series function documentation #380

Closed kdayday closed 2 weeks ago

kdayday commented 2 weeks ago

Add/copy docs strings for get_time_series and get_time_series_keys so they can be imported/exported by PSY. Resulting docs over in PSY:

Screenshot 2024-06-18 at 11 32 25 AM

Screenshot 2024-06-18 at 11 38 20 AM

codecov[bot] commented 2 weeks ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 77.42%. Comparing base (c6f8c35) to head (1ea4c59).

Additional details and impacted files [![Impacted file tree graph](https://app.codecov.io/gh/NREL-Sienna/InfrastructureSystems.jl/pull/380/graphs/tree.svg?width=650&height=150&src=pr&token=I73yjxYxgn&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL-Sienna)](https://app.codecov.io/gh/NREL-Sienna/InfrastructureSystems.jl/pull/380?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL-Sienna) ```diff @@ Coverage Diff @@ ## main #380 +/- ## ======================================= Coverage 77.42% 77.42% ======================================= Files 66 66 Lines 5099 5099 ======================================= Hits 3948 3948 Misses 1151 1151 ``` | [Flag](https://app.codecov.io/gh/NREL-Sienna/InfrastructureSystems.jl/pull/380/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL-Sienna) | Coverage Δ | | |---|---|---| | [unittests](https://app.codecov.io/gh/NREL-Sienna/InfrastructureSystems.jl/pull/380/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL-Sienna) | `77.42% <ø> (ø)` | | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL-Sienna#carryforward-flags-in-the-pull-request-comment) to find out more. | [Files](https://app.codecov.io/gh/NREL-Sienna/InfrastructureSystems.jl/pull/380?dropdown=coverage&src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL-Sienna) | Coverage Δ | | |---|---|---| | [src/time\_series\_interface.jl](https://app.codecov.io/gh/NREL-Sienna/InfrastructureSystems.jl/pull/380?src=pr&el=tree&filepath=src%2Ftime_series_interface.jl&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=NREL-Sienna#diff-c3JjL3RpbWVfc2VyaWVzX2ludGVyZmFjZS5qbA==) | `95.50% <ø> (ø)` | |
daniel-thom commented 2 weeks ago

@daniel-thom can you confirm if we already have in the IS documentation the bulk addition of time series? If not, should we add it?

This section is in PowerSystems. This is about keeping the HDF5 file open, not adding many arrays at once.