API Reference

August 12, 2022 ยท View on GitHub

.. currentmodule:: nemseer

Loader

Use the {meth}`initialise() <nemseer.loader.Loader.initialise()>` class method to create an instance of the {class}`Loader <nemseer.loader.Loader>` object, as this method assembles metadata relevant to NEMSEER cache searching.

.. autoclass:: nemseer.loader.Loader
   :members:

Downloader

Use the {meth}`from_Loader() <nemseer.downloader.ForecastTypeDownloader.from_Loader()>` class method to create an instance of the {class}`ForecastTypeLoader <nemseer.downloader.ForecastTypeDownloader>` object.

.. autoclass:: nemseer.downloader.ForecastTypeDownloader
   :members:

Downloader Helpers

Scrapers

These functions scrape NEMWeb to assist nemseer in validating inputs and providing feedback to users.

.. automodule:: nemseer.dl_helpers.functions
   :members:

Specific validators

These validators are specific to each forecast_type. They are used prior to initiating a download (i.e. via {class}ForecastTypeDownloader <nemseer.downloader.ForecastTypeDownloader>) and check the following:

  • The requested table(s) is (are) available for the provided forecast_start and forecast_end
  • forecast times are compatible with forecasted times. These will depend on the forecast windows of each forecast_type
.. automodule:: nemseer.dl_helpers.validators
   :members: