Skip to content

Organize iotools reference page by data provider #2447

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

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

Organize iotools reference page by data provider #2447

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
157 changes: 136 additions & 21 deletions docs/sphinx/source/reference/iotools.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,21 +11,39 @@ IO Tools
Functions for retrieving, reading, and writing data from a variety
of sources and file formats relevant to solar energy modeling.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
.. contents:: Currently supported APIs
:depth: 3
:local:

Thinking out loud in case you find this relevant.

You may as well try with the default (empty) title.
https://docutils.sourceforge.io/docs/ref/rst/directives.html#table-of-contents

Public datasets
---------------

PVGIS
^^^^^

.. autosummary::
:toctree: generated/

iotools.get_pvgis_tmy
iotools.read_pvgis_tmy
iotools.get_pvgis_hourly
iotools.read_pvgis_hourly
iotools.get_pvgis_horizon


CAMS
^^^^

.. autosummary::
:toctree: generated/

iotools.get_cams
iotools.read_cams
iotools.parse_cams


NSRDB
^^^^^

.. autosummary::
:toctree: generated/

iotools.read_tmy2
iotools.read_tmy3
iotools.read_epw
iotools.parse_epw
iotools.read_srml
iotools.get_srml
iotools.read_surfrad
iotools.read_midc
iotools.read_midc_raw_data_from_nrel
iotools.read_crn
iotools.read_solrad
iotools.get_solrad
iotools.get_nsrdb_psm4_aggregated
iotools.get_nsrdb_psm4_tmy
iotools.get_nsrdb_psm4_conus
Expand All @@ -35,32 +53,129 @@ of sources and file formats relevant to solar energy modeling.
iotools.get_psm3
iotools.read_psm3
iotools.parse_psm3
iotools.get_pvgis_tmy
iotools.read_pvgis_tmy
iotools.get_pvgis_hourly
iotools.read_pvgis_hourly
iotools.get_pvgis_horizon


BSRN
^^^^

.. autosummary::
:toctree: generated/

iotools.get_bsrn
iotools.read_bsrn
iotools.parse_bsrn
iotools.get_cams
iotools.read_cams
iotools.parse_cams


SOLRAD
^^^^^^

.. autosummary::
:toctree: generated/

iotools.read_solrad
iotools.get_solrad


SURFRAD
^^^^^^^

.. autosummary::
:toctree: generated/

iotools.read_surfrad


MIDC
^^^^

.. autosummary::
:toctree: generated/

iotools.read_midc
iotools.read_midc_raw_data_from_nrel


SRML
^^^^

.. autosummary::
:toctree: generated/

iotools.read_srml
iotools.get_srml


ACIS
^^^^

.. autosummary::
:toctree: generated/

iotools.get_acis_prism
iotools.get_acis_nrcc
iotools.get_acis_mpe
iotools.get_acis_station_data
iotools.get_acis_available_stations
iotools.read_panond


CRN
^^^

.. autosummary::
:toctree: generated/

iotools.read_crn



Commercial datasets
-------------------


SolarAnywhere
^^^^^^^^^^^^^

.. autosummary::
:toctree: generated/

iotools.get_solaranywhere
iotools.read_solaranywhere


Solcast
^^^^^^^

.. autosummary::
:toctree: generated/

iotools.get_solcast_tmy
iotools.get_solcast_historic
iotools.get_solcast_forecast
iotools.get_solcast_live


Solargis
^^^^^^^^

.. autosummary::
:toctree: generated/

iotools.get_solargis
Comment on lines +131 to 163
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Would there be any value in listing in alphabetical order within each category? Example below for Commercial datasets:

Suggested change
Commercial datasets
-------------------
SolarAnywhere
^^^^^^^^^^^^^
.. autosummary::
:toctree: generated/
iotools.get_solaranywhere
iotools.read_solaranywhere
Solcast
^^^^^^^
.. autosummary::
:toctree: generated/
iotools.get_solcast_tmy
iotools.get_solcast_historic
iotools.get_solcast_forecast
iotools.get_solcast_live
Solargis
^^^^^^^^
.. autosummary::
:toctree: generated/
iotools.get_solargis
Commercial datasets
-------------------
SolarAnywhere
^^^^^^^^^^^^^
.. autosummary::
:toctree: generated/
iotools.get_solaranywhere
iotools.read_solaranywhere
Solargis
^^^^^^^^
.. autosummary::
:toctree: generated/
iotools.get_solargis
Solcast
^^^^^^^
.. autosummary::
:toctree: generated/
iotools.get_solcast_tmy
iotools.get_solcast_historic
iotools.get_solcast_forecast
iotools.get_solcast_live

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I did struggle with choosing an ordering. For the free datasets, I ordered by what I guessed would be "most useful to the most users". I did not put any thought into the commercial dataset ordering.

Ordering by something easy and obvious would be nice. I'm open to switching to alphabetical (although it would be a shame to have to list the "not even solar resource" ACIS functions first...). I would like to hear from others on this point.



Generic data file readers
-------------------------

.. autosummary::
:toctree: generated/

iotools.read_tmy2
iotools.read_tmy3
iotools.read_epw
iotools.parse_epw
iotools.read_panond


A :py:class:`~pvlib.location.Location` object may be created from metadata
in some files.

Expand Down
Loading