Python API Reference¶
Modeling Framework¶
Apollo’s core API is the modeling framework.
Model Classes
apollo.models.Model |
|
apollo.models.IrradianceModel |
|
apollo.models.NamModel |
Utility Functions
apollo.models.list_models |
|
apollo.models.list_templates |
|
apollo.models.load_model |
|
apollo.models.load_model_at |
|
apollo.models.load_model_from |
|
apollo.models.make_estimator |
|
apollo.models.make_model |
|
apollo.models.make_model_from |
NAM Forecast Data¶
Apollo uses the North American Mesoscale (NAM) forecast system, a numerical weather simulation produced by the National Oceanic and Atmospheric Administration (NOAA). Apollo can be configured to collect NAM forecasts as training data for machine learning models.
Data Access
apollo.nam.download |
|
apollo.nam.open |
|
apollo.nam.open_range |
|
apollo.nam.CacheMiss |
Geographic Coordinates
apollo.nam.NAM218 |
|
apollo.nam.proj_coords |
|
apollo.nam.slice_geo |
Useful Constants
apollo.nam.ATHENS_LATLON |
|
apollo.nam.PLANAR_FEATURES |
See also
- NAM Home Page
- Detailed documentation of NAM.
- National Centers for Environmental Information
- Access to raw NAM forecast data.
- Inventory of File nam.t00z.awphys00.tm00.grib2
- Catalog of variables included in NAM forecasts. (Apollo does not support every variable.)
Feature Extraction¶
apollo.time_of_day |
|
apollo.time_of_year |
|
apollo.is_daylight |
Metrics¶
apollo.metrics.all |
|
apollo.metrics.mae |
|
apollo.metrics.r2 |
|
apollo.metrics.rmse |
|
apollo.metrics.stdae |
Visualizations¶
Apollo includes several visualization routines.
apollo.date_heatmap |
|
apollo.date_heatmap_figure |
|
apollo.nam_figure |
Data Access¶
Apollo stores models and datasets in the Apollo database. The database is a regular directory specified by the APOLLO_DATA environment variable, defaulting to /var/lib/apollo. In the Apollo Docker image, the database is a volume mounted to /apollo-data.
apollo.path |