Documentation ¶
Index ¶
- Variables
- func BuildFilePath(modelDirectory, fileName string) string
- type ControlFiles
- type FileExt
- type ForcingFiles
- type GeometryFiles
- type HmsControlData
- type HmsForcingData
- type HmsGeometryData
- type HmsInputFiles
- type HmsModel
- type HmsModelFiles
- type HmsModelMetadata
- type HmsOutputFiles
- type HmsSupplementalFiles
- type InputFiles
- type Model
- type ModelFiles
- type OutputFiles
- type SupplementalFiles
Constants ¶
This section is empty.
Variables ¶
var GeometryFeatureTypes []string = []string{"Subbasin", "Reach", "Junction", "Source", "Sink", "Reservoir", "Diversion"}
GeometryFeatureTypes ...
Functions ¶
func BuildFilePath ¶
BuildFilePath ... build the file path given its name and the file path of the definition file...
Types ¶
type ControlFiles ¶
ControlFiles ...
type ForcingFiles ¶
ForcingFiles ...
type GeometryFiles ¶
type GeometryFiles struct { Paths []string FeaturesProperties map[string]interface{} // placeholder Georeference interface{} // placeholder }
GeometryFiles is a general type that should contain all data pulled from the models spatial files
type HmsControlData ¶
type HmsControlData struct { Title string Hash string Description string StartDate string `json:"Start Date"` StartTime string `json:"Start Time"` EndDate string `json:"End Date"` EndTime string `json:"End Time"` TimeInterval string `json:"Time Interval"` Notes string }
HmsControlData ...
type HmsForcingData ¶
type HmsForcingData struct { Title string Hash string Description string Units string `json:"Unit System"` MissingToDefault string `json:"Set Missing Data to Default"` Precip string `json:"Precipitation"` SWave string `json:"Short-Wave Radiation"` LWave string `json:"Long-Wave Radiation"` Snowmelt string ET string `json:"Evapotranspiration"` BasinModel []string `json:"Use Basin Model"` Subbasin []string Notes string }
HmsForcingData ...
type HmsGeometryData ¶
type HmsGeometryData struct { Title string Hash string Description string Units string `json:"Unit System"` MissingtoZero string `json:"Missing Flow To Zero"` FlowRatio string `json:"Enable Flow Ratio"` LocalFlow string `json:"Local Flow At Junctions"` SedRouting string `json:"Sediment Routing"` QualityRouting string `json:"Quality Routing"` Features map[string][]string GeoRefFiles []string `json:"Geospatial Reference Files"` CRS string `json:"Coordinate System"` LossRate string `json:"LossRate"` Transform string `json:"Transform"` Notes string }
HmsGeometryData ...
type HmsInputFiles ¶
HmsInputFiles ...
type HmsModel ¶
type HmsModel struct { Type string Title string Version string Description string FileStore filestore.FileStore ModelDirectory string DefinitionFile string DefinitionFileHash string Files HmsModelFiles Metadata HmsModelMetadata }
HmsModel ...
func NewHmsModel ¶
NewHmsModel ...
func (*HmsModel) GeospatialData ¶
func (hm *HmsModel) GeospatialData() interface{}
GeospatialData ...
type HmsModelFiles ¶
type HmsModelFiles struct { InputFiles HmsInputFiles OutputFiles HmsOutputFiles SupplementalFiles HmsSupplementalFiles }
HmsModelFiles ...
func (HmsModelFiles) Paths ¶
func (mf HmsModelFiles) Paths() []string
Paths will pull all paths from the HmsInputFiles, HmsOutputFiles, and HmsSupplementalFiles members of the model type
type HmsModelMetadata ¶
type HmsModelMetadata struct { ControlMetadata map[string]HmsControlData ForcingMetadata map[string]HmsForcingData GeometryMetadata map[string]HmsGeometryData }
HmsModelMetadata ...
type HmsOutputFiles ¶
HmsOutputFiles ...
type HmsSupplementalFiles ¶
type HmsSupplementalFiles struct { GridFiles []string VisualizationFiles []string ObservationFiles []string }
HmsSupplementalFiles ...
type InputFiles ¶
type InputFiles struct { ControlFiles ControlFiles ForcingFiles ForcingFiles GeometryFiles GeometryFiles SimulationVariables interface{} // placeholder LocalVariables interface{} // placeholder }
InputFiles is a general type that should contain all data pulled from the models input files
type Model ¶
type Model struct { Type string Version string DefinitionFile string DefinitionFileHash string Files ModelFiles }
Model is a general type should contain all necessary data for a model of any type.
type ModelFiles ¶
type ModelFiles struct { InputFiles InputFiles OutputFiles OutputFiles SupplementalFiles SupplementalFiles }
ModelFiles ...
type OutputFiles ¶
type OutputFiles struct { Paths []string ModelPrediction interface{} // placeholder RunFiles []string RunLogs []string }
OutputFiles is a general type that should contain all data pulled from the models output files
type SupplementalFiles ¶
type SupplementalFiles struct { Paths []string Visulizations interface{} // placeholder ObservationalData interface{} // placeholder }
SupplementalFiles is a general type that should contain all data pulled from the models supplemental files