Information about the temporal frequency of archived data.

• start: Beginning of time of the time series.

• frequency: Interval between each record.

• centerpoints: Time representing the temporal center of each record.

DataSetInterpolators are used to interpolate data from a FileSet to represent a given time and location. Data is loaded (and downloaded) lazily, so the first time you use it on a for a given dataset and time period it may take a while to load. Each time step is downloaded and loaded as it is needed during the simulation and cached on the hard drive at the path specified by the \$EARTHSCIDATADIR environment variable, or in a scratch directory if that environment variable has not been specified. The interpolator will also cache data in memory representing the data records for the times immediately before and after the current time step.

varname is the name of the variable to interpolate. default_time is the time to use when initializing the interpolator. spatial_ref is the spatial reference system that the simulation will be using. cache_size is the number of time steps that should be held in the cache at any given time (default=3). (For gridded simulations where all grid cells are computed synchronously, a cache_size of 2 is best, but if the grid cells are not all time stepping together, a cache_size of 3 or more is best.)

An interface for types describing a dataset, potentially comprised of multiple files.

To satisfy this interface, a type must implement the following methods:

• relpath(fs::FileSet, t::DateTime)
• url(fs::FileSet, t::DateTime)
• localpath(fs::FileSet, t::DateTime)
• DataFrequencyInfo(fs::FileSet, t::DateTime)::DataFrequencyInfo
• loadmetadata(fs::FileSet, t::DateTime, varname)::MetaData
• loadslice!(cache::AbstractArray, fs::FileSet, t::DateTime, varname)
• varnames(fs::FileSet, t::DateTime)

GEOS-FP data as archived for use with GEOS-Chem classic.

Domain options (as of 2022-01-30):

• 4x5
• 0.125x0.15625_AS
• 0.125x0.15625_EU
• 0.125x0.15625_NA
• 0.25x0.3125
• 0.25x0.3125_AF
• 0.25x0.3125_AS
• 0.25x0.3125_CH
• 0.25x0.3125_EU
• 0.25x0.3125_ME
• 0.25x0.3125_NA
• 0.25x0.3125_OC
• 0.25x0.3125_RU
• 0.25x0.3125_SA
• 0.5x0.625
• 0.5x0.625_AS
• 0.5x0.625_CH
• 0.5x0.625_EU
• 0.5x0.15625_NA
• 2x2.5
• 4x5
• C180
• C720
• NATIVE
• c720

Possible filetypes are:

• :A1
• :A3cld
• :A3dyn
• :A3mstC
• :A3mstE
• :I3

See http://geoschemdata.wustl.edu/ExtData/ for current options.

Information about a data array.

• coords: The locations associated with each data point in the array.

• units: Physical units of the data, e.g. m s⁻¹.

• description: Description of the data.

• dimnames: Dimensions of the data, e.g. (lat, lon, layer).

• varsize: Dimension sizes of the data, e.g. (180, 360, 30).

• native_sr: The spatial reference system of the data, e.g. "EPSG:4326" for lat-lon data.

• xdim: The index number of the x-dimension (e.g. longitude)

• ydim: The index number of the y-dimension (e.g. latitude)

Archived CMAQ emissions data.

Currently, only data for year 2016 is available.

Create an EarthSciMLBase.Operator to write simulation output to a NetCDF file.

• filepath::String: The path of the NetCDF file to write to

• file::Any: The netcdf dataset

• vars::Any: The netcdf variables corresponding to the state variables

• tvar::Any: The netcdf variable for time

• time_interval::AbstractFloat: Times interval (in seconds) at which to write to disk

• extra_vars::AbstractVector: Extra observed variables to write to disk

• dtype::Any: Data type of the output

GEOSFP(
    domain,
    t;
    coord_defaults,
    spatial_ref,
    dtype,
    kwargs...
)

A data loader for GEOS-FP data as archived for use with GEOS-Chem classic.

Domain options (as of 2022-01-30):

• 4x5
• 0.125x0.15625_AS
• 0.125x0.15625_EU
• 0.125x0.15625_NA
• 0.25x0.3125
• 0.25x0.3125_AF
• 0.25x0.3125_AS
• 0.25x0.3125_CH
• 0.25x0.3125_EU
• 0.25x0.3125_ME
• 0.25x0.3125_NA
• 0.25x0.3125_OC
• 0.25x0.3125_RU
• 0.25x0.3125_SA
• 0.5x0.625
• 0.5x0.625_AS
• 0.5x0.625_CH
• 0.5x0.625_EU
• 0.5x0.15625_NA
• 2x2.5
• 4x5
• C180
• C720
• NATIVE
• c720

coord_defaults can be used to provide default values for the coordinates of the domain. For example if we want to perform a 2D simulation with a vertical dimension, we can set coord_defaults = Dict(:lev => 1).

dtype represents the desired data type of the interpolated values. The native data type for this dataset is Float32.

See http://geoschemdata.wustl.edu/ExtData/ for current options.

NEI2016MonthlyEmis(
    sector,
    t,
    x,
    y,
    lev,
    Δz;
    spatial_ref,
    dtype,
    kwargs...
)

A data loader for CMAQ-formatted monthly US National Emissions Inventory data for year 2016, available from: https://gaftp.epa.gov/Air/emismod/2016/v1/gridded/monthly_netCDF/. The emissions here are monthly averages, so there is no information about diurnal variation etc.

spatial_ref should be the spatial reference system that the simulation will be using. x and y, and should be the coordinate variables and grid spacing values for the simulation that is going to be run, corresponding to the given x and y values of the given spatial_ref, and the lev represents the variable for the vertical grid level. x and y must be in the same units as spatial_ref.

dtype represents the desired data type of the interpolated values. The native data type for this dataset is Float32.

NOTE: This is an interpolator that returns an emissions value by interpolating between the centers of the nearest grid cells in the underlying emissions grid, so it may not exactly conserve the total emissions mass, especially if the simulation grid is coarser than the emissions grid.

Example

using EarthSciData, ModelingToolkit, Unitful
@parameters t lat lon lev
@parameters Δz = 60 [unit=u"m"]
emis = NEI2016MonthlyEmis("mrggrid_withbeis_withrwc", t, lon, lat, lev, Δz)

Asynchronously load data, anticipating which time will be requested next.

Return the index of the centerpoint closest to the given time.

create_interp_equation(
    itp,
    filename,
    t,
    sample_time,
    coords;
    wrapper_f
)

Create an equation that interpolates the given dataset at the given time and location. filename is an identifier for the dataset, and t is the time variable. wrapper_f can specify a function to wrap the interpolated value, for example eq -> eq / 2 to divide the interpolated value by 2.

Return the current interpolation time point for this interpolator.

description(itp, t)

Return the description of the data associated with this interpolator.

dimnames(itp, t)

Return the dimension names associated with this interpolator.

Return the time endpoints correcponding to each centerpoint

Get the NCDataset for the given file path, caching the last 20 files.

interp!(itp, t, locs)

Return the value of the given variable from the given dataset at the given time and location.

Interpolation with a unix timestamp.

Load the time points that should be cached in this interpolator.

Interpolate without checking if the data has been correctly loaded for the given time.

loadmetadata(fs, t, varname)

Load the data for the given variable name at the given time.

loadmetadata(fs, t, varname)

Load the data for the given variable name at the given time.

loadslice!(data, fs, t, varname)

Load the data in place for the given variable name at the given time.

loadslice!(data, fs, t, varname)

Load the data in place for the given variable name at the given time.

localpath(fs, t)

Return the local path for the file for the given DateTime.

maybedownload(fs, t)

Check if the specified file exists locally. If not, download it.

Return the next interpolation time point for this interpolator.

partialderivatives_δPδlev_geosfp(geosfp; default_lev)

Return a function to calculate coefficients to multiply the δ(u)/δ(lev) partial derivative operator by to convert a variable named u from δ(u)/δ(lev)toδ(u)/δ(P), i.e. from vertical level number to pressure in hPa. The return format iscoordinateindex => conversionfactor`.

Return the previous interpolation time point for this interpolator.

prune!(pde_sys, prefix)

Remove equations from a PDESystem where a variable in the LHS contains the given prefix but none of the equations have an RHS containing that variable. This can be used to remove data loading equations that are not used in the final model.

relpath(fs, t)

File path on the server relative to the host root; also path on local disk relative to ENV["EARTHSCIDATADIR"] (or a scratch directory if that environment variable is not set).

relpath(fs, t)

File path on the server relative to the host root; also path on local disk relative to ENV["EARTHSCIDATADIR"].

Convert a string to a Unitful object.

units(itp, t)

Return the units of the data associated with this interpolator.

url(fs, t)

Return the URL for the file for the given DateTime.

varnames(fs, t)

Return the variable names associated with this FileSet.

varnames(fs, t)

Return the variable names associated with this FileSet.

Close the NetCDF file

Set up the output file.

Write the current state of the Simulator to the NetCDF file.

Return the interval at which to write the simulation state to disk.

Return the units of the data.