aeputil

type InventoryConfig struct {
	// NEIFiles lists National Emissions Inventory emissions files.
	// The file names can include environment variables.
	// The format is map[sector name][list of files].
	NEIFiles map[string][]string

	// COARDSFiles lists COARDS-compliant NetCDF emission files
	// (NetCDF 4 and greater not supported).
	// Information regarding the COARDS NetCDF conventions are
	// available here: https://ferret.pmel.noaa.gov/Ferret/documentation/coards-netcdf-conventions.
	// The file names can include environment variables.
	// The format is map[sector name][list of files].
	// For COARDS files, the sector name will also be used
	// as the SCC code.
	COARDSFiles map[string][]string

	// COARDSYear specifies the year of emissions for COARDS emissions files.
	// COARDS emissions are assumed to be in units of mass of emissions per year.
	// The year will not be used for NEI emissions files.
	COARDSYear int

	// PolsToKeep lists pollutants from the NEI that should be kept.
	PolsToKeep aep.Speciation

	// InputUnits specifies the units of input data. Acceptable
	// values are `tons', `tonnes', `kg', `g', and `lbs'.
	InputUnits string

	// SrgSpecSMOKE gives the location of the SMOKE-formatted
	// surrogate specification file, if any.
	SrgSpecSMOKE string

	// SrgSpecOSM gives the location of the OSM-formatted
	// surrogate specification file, if any.
	SrgSpecOSM string

	// PostGISURL specifies the URL to use to connect to a PostGIS database
	// with the OpenStreetMap data loaded. The URL should be in the format:
	// postgres://username:password@hostname:port/databasename".
	//
	// The OpenStreetMap data can be loaded into the database using the
	// osm2pgsql program, for example with the command:
	// osm2pgsql -l --hstore-all --hstore-add-index --database=databasename --host=hostname --port=port --username=username --create planet_latest.osm.pbf
	//
	// The -l and --hstore-all flags for the osm2pgsql command are both necessary,
	// and the PostGIS database should have the "hstore" extension installed before
	// loading the data.
	PostGISURL string

	// SrgShapefileDirectory gives the location of the directory holding
	// the shapefiles used for creating spatial surrogates.
	// It is used for assigning spatial locations to emissions records.
	SrgShapefileDirectory string

	// GridRef specifies the locations of the spatial surrogate gridding
	// reference files used for processing emissions.
	// It is used for assigning spatial locations to emissions records.
	GridRef []string

	// SCCExactMatch specifies whether SCC codes must match exactly when processing
	// emissions.
	SCCExactMatch bool

	// FilterFunc specifies which records should be kept.
	// If it is nil, all records are kept.
	FilterFunc aep.RecFilter
}

type Iterator interface {
	// Next returns the next record.
	Next() (aep.Record, error)

	// Report returns an emissions report on the records that have been
	// processed by this iterator.
	Report() *aep.InventoryReport
}

type ScaleFunc func(aep.Record, aep.Pollutant) (float64, error)

type SpatialConfig struct {
	// SrgSpecSMOKE gives the location of the SMOKE-formatted
	// surrogate specification file, if any.
	SrgSpecSMOKE string

	// SrgSpecOSM gives the location of the OSM-formatted
	// surrogate specification file, if any.
	SrgSpecOSM string

	// PostGISURL specifies the URL to use to connect to a PostGIS database
	// with the OpenStreetMap data loaded. The URL should be in the format:
	// postgres://username:password@hostname:port/databasename".
	//
	// The OpenStreetMap data can be loaded into the database using the
	// osm2pgsql program, for example with the command:
	// osm2pgsql -l --hstore-all --hstore-add-index --database=databasename --host=hostname --port=port --username=username --create planet_latest.osm.pbf
	//
	// The -l and --hstore-all flags for the osm2pgsql command are both necessary,
	// and the PostGIS database should have the "hstore" extension installed before
	// loading the data.
	PostGISURL string

	// SrgShapefileDirectory gives the location of the directory holding
	// the shapefiles used for creating spatial surrogates.
	SrgShapefileDirectory string

	// SCCExactMatch specifies whether SCC codes must match exactly when processing
	// emissions.
	SCCExactMatch bool

	// GridRef specifies the locations of the spatial surrogate gridding
	// reference files used for processing the NEI.
	GridRef []string

	// OutputSR specifies the output spatial reference in Proj4 format.
	OutputSR string

	// InputSR specifies the input emissions spatial reference in Proj4 format.
	InputSR string

	// SimplifyTolerance is the tolerance for simplifying spatial surrogate
	// geometry, in units of OutputSR.
	SimplifyTolerance float64

	// SpatialCache specifies the location for storing spatial emissions
	// data for quick access. If this is left empty, no cache will be used.
	SpatialCache string

	// SrgDataCache specifies the location for caching spatial surrogate input data.
	// If it is empty, the input surrogate data will be stored in SpatialCache.
	SrgDataCache string

	// MaxCacheEntries specifies the maximum number of emissions and concentrations
	// surrogates to hold in a memory cache. Larger numbers can result in faster
	// processing but increased memory usage.
	MaxCacheEntries int

	// GridCells specifies the geometry of the spatial grid.
	GridCells []geom.Polygonal

	// GridName specifies a name for the grid which is used in the names
	// of intermediate and output files.
	// Changes to the geometry of the grid must be accompanied by either a
	// a change in GridName or the deletion of all the files in the
	// SpatialCache directory.
	GridName string
	// contains filtered or unexported fields
}

type SpatialIterator struct {
	// contains filtered or unexported fields
}

type SpeciateConfig struct {
	// These variables specify the locations of files used for
	// chemical speciation.
	SpecRef, SpecRefCombo, SpeciesProperties, GasProfile   string
	GasSpecies, OtherGasSpecies, PMSpecies, MechAssignment string
	MolarWeight, SpeciesInfo                               string

	// ChemicalMechanism specifies which chemical mechanism to
	// use for speciation.
	ChemicalMechanism string

	// MassSpeciation specifies whether to use mass speciation.
	// If false, speciation will convert values to moles.
	MassSpeciation bool

	// SCCExactMatch specifies whether SCCs should be expected to match
	// exactly with the the speciation reference, or if partial matches
	// are acceptable.
	SCCExactMatch bool

	Speciation aep.Speciation
	// contains filtered or unexported fields
}

type SpeciatedRecord struct {
	aep.Record
	// contains filtered or unexported fields
}