Description of HydroShare Resource Types and Metadata Terms

HydroShare Resource Types

A "resource" is the discrete unit of digital content within HydroShare. Resources are social objects that can be created, modified, versioned, shared, annotated, discovered, and accessed. A resource is the granular unit used for management and access control within HydroShare. Persistent identifiers, access control, versioning, sharing, and discovery are all managed at the resource level. Each resource type has a set of metadata elements that are standard across all resource types and may have resource type specific metadata elements that are defined in the sections below. The following terms define the types of resources that can be created in HydroShare:

• Term: CompositeResource
• URI: http://www.hydroshare.org/terms/CompositeResource
• Label: Composite Resource
• Description: Composite is the default resource type in HydroShare. A composite resource is a resource that can include multiple files without file format limitations. This resource type is intended to support metadata and data functions at both resource level and at the level of individual files and groupings of files (referred to formally as aggregations). A composite resource should be used when it is desirable to create a single resource (e.g., one resource to manage, share, or discover) that may have content of mixed types (e.g., geographic feature, raster, time series, etc.).

• Term: CollectionResource
• URI: http://www.hydroshare.org/terms/CollectionResource
• Label: Collection Resource
• Description: A collection resource is a resource that holds a list of other resources in HydroShare. Collections are intended to be a flexible and logical way to combine resources associated with a specific purpose (e.g., a specific study, site, or experiment). HydroShare does not impose restrictions on the purpose for which resources may be placed in a collection or on the number, types, publication status, or permissions settings associated with resources in a collection. A collection resource should be used when it is desirable for each of the component parts to be separately shareable, discoverable, and publishable resources.

• Term: GenericResource
• URI: http://www.hydroshare.org/terms/GenericResource
• Label: Generic Resource
• Description: A generic resource is an arbitrary file or collection of files that are logically grouped together as a resource. Generic resources have been superseded by composite resources.

• Term: GeographicFeatureResource
• URI: http://www.hydroshare.org/terms/GeographicFeatureResource
• Label: Geographic Feature Resource
• Description: A geographic feature resource is a set of point, line, or polygon features stored in ESRI Shapefile format. The Shapefile format is comprised of multiple files including files with .shp, .shx, .dbf, and .prj extensions. The minmum required files are the following: .shp, .shx, .dbf, and .prj, but can also include, .sbx, .sbn, .cpg, .xml, .fbn, .fbx, .ain, .aih, .atx, .ixs, and .mxs files. Each of these files stores a different type of data such as the vectors, projection information, attribute data, and metadata. Geographic feature resources have been superseded by the geographic feature aggregation type in composite resources. A single composite resource with a geographic feature aggregation is equivalent to a geographic feature resource.

• Term: GeographicRasterResource
• URI: http://www.hydroshare.org/terms/GeographicRasterResource
• Label: Geographic Raster Resource
• Description: A geographic raster is a gridded representation of geographic data saved using the GDAL Virtual Raster Dataset (VRT) format. A Virtual Raster dataset (VRT) is an assembly of “.tif” files with a “.vrt” text (XML) file that contains a list of the member “.tif” files that make up the virtual geographic raster. Each of the “.tif” files can have different file names. Geographic raster resources have been superseded by the geographic raster aggregation type in composite resources. A single composite resource with a geographic raster aggregation is equivalent to a geographic raster resource.

• Term: ModelProgramResource
• URI: http://www.hydroshare.org/terms/ModelProgramResource
• Label: Model Program Resource
• Description: A model program resource describes the software component of a generic model within the water domain. It aims to fully describe the software-related metadata of a given model program to enable scientists to seamlessly retrieve all the content and information required to get a model up-and-running on their local or server-side machine. This resource consists of uploaded content such as source code, compiled binaries, and documentation, as well as metadata describing the model's software. The model program resource can be related to many model instance resources to completely describe a simulation and the exact software version used for a particular study to make data replication possible.

• Term: ModelInstanceResource
• URI: http://www.hydroshare.org/terms/ModelInstanceResource
• Label: Model Instance Resource
• Description: A model instance resource defines the input and output data for a generic hydrological model for a specific time and place. A model instance resource consists of specific metadata to describe the model content as well as a reference to the model program resource that is used to execute a simulation.

• Term: MODFLOWModelInstanceResource
• URI: http://www.hydroshare.org/terms/MODFLOWModelInstanceResource
• Label: MODFLOW Model Instance Resource
• Description: A MODFLOW model instance resource is a model instance resource that has been enhanced to hold data for the MODFLOW groundwater flow model.

• Term: SWATModelInstanceResource
• URI: http://www.hydroshare.org/terms/SWATModelInstanceResource
• Label: SWAT Model Instance Resource
• Description: A SWAT model instance resource is a model instance resource that has been enhanced to hold data for the Soil and Water Assessment (SWAT) model.

• Term: MultidimensionalResource
• URI: http://www.hydroshare.org/terms/MultidimensionalResource
• Label: Multidimensional Resource
• Description: A multidimensional (NetCDF) resource is designed to support multidimensional space-time data using the NetCDF file format. NetCDF contains self-describing metadata and supports the creation of an array-oriented dataset, which may include three spatial dimensions, a time dimension and other user defined dimensions. NetCDF files are binary files, but a readable header file is produced in a “common data language” (CDL) format by the ncdump function. In HydroShare, both this text file and the binary file are saved. Multidimensional resources have been superseded by the multidimensional aggregation type in composite resources. A single composite resource with a multidimensional aggregation is equivalent to a multidimensional resource.

• Term: ReferencedTimeSeriesResource
• URI: http://www.hydroshare.org/terms/ReferencedTimeSeriesResource
• Label: Referenced Time Series Resource
• Description: The referenced time series resource was designed to point to, or hold the reference to a time series available in WaterML format on a CUAHSI HydroServer, catalogued in CUAHSI HIS Central, and accessible through data.cuahsi.org. This resource type has been deprecated and has been replaced by the referenced time series aggregation type in a composite resource.

• Term: TimeSeriesResource
• URI: http://www.hydroshare.org/terms/TimeSeriesResource
• Label: Time Series Resource
• Description: A time series resource holds time series data stored using Version 2 of the Observations Data Model (ODM2) in a SQLite database file. A time series resource can be created from an ODM2 SQLite file or from a .csv file that becomes part of the resource. Time series resources have been superseded by the time series aggregation type in composite resources. A single composite resource with a time series aggregation is equivalent to a time series resource.

• Term: WebAppResource
• URI: http://www.hydroshare.org/terms/WebAppResource
• Label: Web App Resource
• Description: A Web App resource is a shortcut (or reference) to an external web application that functions with HydroShare data resources. A Web App can be a simple webpage, a resource viewer, a data editor, or a complex scientific model. Third-party web applications can access HydroShare data resources using the HydroShare representational state transfer (REST) web service application programming interface (API), link to specific HydroShare resource types, and be made discoverable within HydroShare by registration as a Web App resource.

Metadata terms for the Generic Resource Type

To describe the entities of a Generic resource in HydroShare, we chose the standard Dublin Core metadata elements as the resource science metadata. Each of these elements are defined below. All resource types in HydroShare use the standard Dublin Core metadata elements, but some resource types use additional, resource type-specific metadata terms as defined in the following sections.

• Term: name
• URI: http://www.hydroshare.org/terms/name
• Label: Name
• Description: Name of the creator or contributor.

• Term: creatorOrder
• URI: http://www.hydroshare.org/terms/creatorOrder
• Label: Creator Order
• Description: Number used to specify the order of the authorship for the dataset creator.

• Term: organization
• URI: http://www.hydroshare.org/terms/organization
• Label: Organization
• Description: The organization associated with the creator or contributor.

• Term: address
• URI: http://www.hydroshare.org/terms/address
• Label: Address
• Description: The address associated with the creator or contributor.

• Term: email
• URI: http://www.hydroshare.org/terms/email
• Label: Email
• Description: The email for contact with the creator or contributor.

• Term: phone
• URI: http://www.hydroshare.org/terms/phone
• Label: Phone
• Description: The phone number for contact with the creator or contributor.

• Term: homepage
• URI: http://www.hydroshare.org/terms/homepage
• Label: Homepage
• Description: The homepage used to provide additional detailed information of the creator or contributor.

• Term: doi
• URI: http://www.hydroshare.org/terms/doi
• Label: DOI
• Description: The digitial object identifier for the resource which is published in HydroShare.

• Term: hydroshareIdentifier
• URI: http://www.hydroshare.org/terms/hydroshareIdentifier
• Label: HydroShare Identifier
• Description: The UUID assigned to each Hydroshare resource.

• Term: publisherName
• URI: http://www.hydroshare.org/terms/publisherName
• Label: Publisher Name
• Description: The name of the dataset publisher.

• Term: publisherURL
• URI: http://www.hydroshare.org/terms/publisherURL
• Label: Publisher URL
• Description: The URL link pointing to the website with publisher information.

• Term: rightsStatement
• URI: http://www.hydroshare.org/terms/rightsStatement
• Label: Rights Statement
• Description: A text statement that points to a rights management or usage statement for the resource.

• Term: URL
• URI: http://www.hydroshare.org/terms/URL
• Label: Uniform Resource Locator
• Description: URL that points to a rights management or usage statement for the resource.

• Term: isCopiedFrom
• URI: http://www.hydroshare.org/terms/isCopiedFrom
• Label: Copied From
• Description: Name or URL of the source from which a resource is copied.

• Term: isHostedBy
• URI: http://www.hydroshare.org/terms/isHostedBy
• Label: Hosted By
• Description: Name or URL of the external system where a resource is located.

• Term: extendedMetadata
• URI: http://www.hydroshare.org/terms/extendedMetadata
• Label: Extended Metadata
• Description: User defined key/value pair metadata.

• Term: key
• URI: http://www.hydroshare.org/terms/key
• Label: Key
• Description: The content of the key for key/value pair extended metadata.

• Term: value
• URI: http://www.hydroshare.org/terms/value
• Label: Value
• Description: The content of the value for key/value pair extended metadata.

• Term: ORCID
• URI: http://www.hydroshare.org/terms/ORCID
• Label: ORCID
• Description: Personal identifier in the ORCID system.

• Term: ResearchGateID
• URI: http://www.hydroshare.org/terms/ResearchGateID
• Label: ResearchGateID
• Description: Personal ResearchGate profile page URL.

• Term: ResearcherID
• URI: http://www.hydroshare.org/terms/ResearcherID
• Label: ResearcherID
• Description: Personal identifier in the ResearcherID system.

• Term: GoogleScholarID
• URI: http://www.hydroshare.org/terms/GoogleScholarID
• Label: GoogleScholarID
• Description: Personal Google Scholar profile page URL.

Metadata terms for the Time Series Resource Type

The time series resource type is based on version 2.0 of the Observations data model. You can learn more about ODM2 at htt://www.odm2.org. Some of the metadata terms for the time series resource type are based on controlled vocabularies for ODM2 that are managed at http://vocabulary.odm2.org.

• Term: site
• URI: http://www.hydroshare.org/terms/site
• Label: Site
• Description: The location at which the time series was observed or generated.

• Term: SiteCode:
• URI: http://www.hydroshare.org/terms/SiteCode
• Label: Site Code
• Description: A code used to represent the site.

• Term: SiteName:
• URI: http://www.hydroshare.org/terms/SiteName
• Label: Site Name
• Description: The name of the site.

• Term: SiteType
• URI: http://www.hydroshare.org/terms/SiteType
• Label: Site Type
• Description: A categorization of sites that indicates the type of "Feature of Interest" that the site was established to measure.

• Term: Elevation_m:
• URI: http://www.hydroshare.org/terms/Elevation_m
• Label: Elevation_m
• Description: The elevation of the site with the unit as meter.

• Term: ElevationDatum
• URI: http://www.hydroshare.org/terms/ElevationDatum
• Label: Elevation Datum
• Description: The datum used for the elevation of the site.

• Term: method
• URI: http://www.hydroshare.org/terms/ts_method
• Label: Method
• Description: The procedure used to create the time series.

• Term: MethodCode
• URI: http://www.hydroshare.org/terms/MethodCode
• Label: Method Code
• Description: A code used to represent the method.

• Term: MethodName
• URI: http://www.hydroshare.org/terms/MethodName
• Label: Method Name
• Description: The name of the method.

• Term: MethodType
• URI: http://www.hydroshare.org/terms/MethodType
• Label: Method Type
• Description: This is choosen from a controlled vocabulary to indicate the category of method.

• Term: MethodDescription
• URI: http://www.hydroshare.org/terms/MethodDescription
• Label: Method Description
• Description: Detailed description of the method.

• Term: MethodLink
• URI: http://www.hydroshare.org/terms/MethodLink
• Label: Method Link
• Description: A URL that provides further details of the method.

• Term: variable
• URI: http://www.hydroshare.org/terms/variable
• Label: Variable
• Description: The phenomenon that the time series represents.

• Term: VariableCode
• URI: http://www.hydroshare.org/terms/VariableCode
• Label: Variable Code
• Description: Code used to represent the variable.

• Term: VariableName
• URI: http://www.hydroshare.org/terms/VariableName
• Label: Variable Name
• Description: A controlled vocabulary used to name variables.

• Term: VariableType
• URI: http://www.hydroshare.org/terms/VariableType
• Label: Variable Type
• Description: A way to group variables into categories for easier querying and filtering. Variable types are selected from a controlled vocabulary.

• Term: NoDataValue
• URI: http://www.hydroshare.org/terms/NoDataValue
• Label: No Data Value
• Description: Placeholders to indicate that no value was observed or recorded, but a value should have been recorded.

• Term: VariableDefinition
• URI: http://www.hydroshare.org/terms/VariableDefinition
• Label: Variable Definition
• Description: Additional information to describe the variable being observed.

• Term: Speciation
• URI: http://www.hydroshare.org/terms/Speciation
• Label: Speciation
• Description: The chemical speciation in which the ResultValues are expressed. Values for speciation are selected from a controlled vocabulary.

• Term: processingLevel
• URI: http://www.hydroshare.org/terms/processingLevel
• Label: Processing Level
• Description: Level of processing or quality control to which the time series has been subjected.

• Term: ProcessingLevelCode
• URI: http://www.hydroshare.org/terms/ProcessingLevelCode
• Label: Processing Level Code
• Description: A code used to represent the processing level.

• Term: Definition
• URI: http://www.hydroshare.org/terms/Definition
• Label: Definition
• Description: The defined name of the processing level.

• Term: Explanation
• URI: http://www.hydroshare.org/terms/Explanation
• Label: Explanation
• Description: Detailed information to describe what the processing level means.

• Term: timeSeriesResult
• URI: http://www.hydroshare.org/terms/timeSeriesResult
• Label: Time Series Result
• Description: The specific action or event that created the time series.

• Term: UnitsType
• URI: http://www.hydroshare.org/terms/UnitsType
• Label: Units Type
• Description: Type of the units.

• Term: UnitsName
• URI: http://www.hydroshare.org/terms/UnitsName
• Label: Units Name
• Description: Name of the units.

• Term: UnitsAbbreviation
• URI: http://www.hydroshare.org/terms/UnitsAbbreviation
• Label: Units Abbreviation
• Description: Abbreviation of the units.

• Term: Status
• URI: http://www.hydroshare.org/terms/Status
• Label: Status
• Description: The status of the result.

• Term: SampleMedium
• URI: http://www.hydroshare.org/terms/SampleMedium
• Label: Sample Medium
• Description: The physical medium that is sampled.

• Term: ValueCount
• URI: http://www.hydroshare.org/terms/ValueCount
• Label: Value Count
• Description: The count of values of the time series result.

• Term: AggregationStatistics
• URI: http://www.hydroshare.org/terms/AggregationStatistics
• Label: Aggregation Statistics
• Description: Statistical method used for spatial or temporal aggregation of the result.

Metadata terms for the Reference Time Series Resource Type

• Term: ReferenceURL
• URI: http://www.hydroshare.org/terms/refts_ReferenceURL
• Label: Reference URL
• Description: RefTS resource metadata

• Term: value
• URI: http://www.hydroshare.org/terms/refts_value
• Label: value
• Description: The URL this RefTS resource is referencing.

• Term: type
• URI: http://www.hydroshare.org/terms/refts_type
• Label: type
• Description: Connection type of the URL (REST or SOAP).

• Term: Method
• URI: http://www.hydroshare.org/terms/refts_method
• Label: Method
• Description: Connection type of the URL (REST or SOAP).

• Term: QualityControlLevel
• URI: http://www.hydroshare.org/terms/refts_QualityControlLevel
• Label: QualityControlLevel
• Description: Quality control level code.

• Term: Variable
• URI: http://www.hydroshare.org/terms/refts_Variable
• Label: Variable
• Description: The measuring object information of this dataset.

• Term: name
• URI: http://www.hydroshare.org/terms/refts_name
• Label: name
• Description: The name of the measuring object.

• Term: code
• URI: http://www.hydroshare.org/terms/refts_code
• Label: code
• Description: The code of the measuring object.

• Term: data_type
• URI: http://www.hydroshare.org/terms/refts_data_type
• Label: data_type
• Description: Date type of the measuring object.

• Term: sample_medium
• URI: http://www.hydroshare.org/terms/refts_sample_medium
• Label: sample_medium
• Description: Sample medium of the measuring object.

• Term: Site
• URI: http://www.hydroshare.org/terms/refts_Site
• Label: Site
• Description: Site information of this dataset.

• Term: name
• URI: http://www.hydroshare.org/terms/site_name
• Label: name
• Description: Site name.

• Term: code
• URI: http://www.hydroshare.org/terms/site_code
• Label: code
• Description: Site code.

• Term: latitude
• URI: http://www.hydroshare.org/terms/refts_latitude
• Label: latitude
• Description: Site latitude.

• Term: longitude
• URI: http://www.hydroshare.org/terms/refts_longitude
• Label: longitude
• Description: Site longitude.

Metadata terms for the Multidimensional (NetCDF) Resource Type

• Term: spatialReference
• URI: http://www.hydroshare.org/terms/nc_spatialReference
• Label: Spatial Reference
• Description: The coordinate reference system and spatial extent information defined in the NetCDF file.

• Term: crsName
• URI: http://www.hydroshare.org/terms/crsName
• Label: Coordinate Reference System Name
• Description: The name of the coordinate reference system.

• Term: crsRepresentationType
• URI: http://www.hydroshare.org/terms/crsRepresentationType
• Label: Coordinate Reference System Representation Type
• Description: The type of the string text used to express the coordinate reference system. Three types are supported including Proj4 spring, EPSG code, and OGC WKT projection.

• Term: crsRepresentationText
• URI: http://www.hydroshare.org/terms/crsRepresenationText
• Label: Coordinate Reference System Representation Text
• Description: The string text used to express the coordinate reference system based on the given representation type.

• Term: extent
• URI: http://www.hydroshare.org/terms/extent
• Label: Extent
• Description: The spatial extent of the dataset including north limit, south limit, east limit, west limit and the corresponding units of the extent.

• Term: netcdfVariable
• URI: http://www.hydroshare.org/terms/netcdfVariable
• Label: NetCDF Variable
• Description: The variables defined in the NetCDF file representing the multidimensional space-time data.

• Term: name
• URI: http://www.hydroshare.org/terms/name_nc
• Label: Name
• Description: The defined name of the NetCDF variable. This name may not explicitly explain what variable it actually represents.

• Term: unit
• URI: http://www.hydroshare.org/terms/nc_unit
• Label: Unit
• Description: The unit of the NetCDF variable.

• Term: type
• URI: http://www.hydroshare.org/terms/type
• Label: Type
• Description: The data type of the variable which is upported in the NetCDF enhanced data model.

• Term: shape
• URI: http://www.hydroshare.org/terms/shape
• Label: Shape
• Description: The shape defined for the variable.

• Term: longName
• URI: http://www.hydroshare.org/terms/longName
• Label: Long Name
• Description: A descriptive name for the NetCDF variable to explain what the variable represents.

• Term: comment
• URI: http://www.hydroshare.org/terms/comment
• Label: Comment
• Description: Miscellaneous information about the variable.

• Term: missingValue
• URI: http://www.hydroshare.org/terms/missingValue
• Label: Missing Value
• Description: The data value used to represent missing data value . The data type for missing value should be the same as the variable type.

Metadata terms for the Geographic Raster Resource Type

• Term: spatialReference
• URI: http://www.hydroshare.org/terms/rt_spatialReference
• Label: Spatial Reference
• Description: The coordinate reference system and spatial extent information defined in GeoTIFF file.

• Term: box
• URI: http://www.hydroshare.org/terms/box
• Label: Box
• Description: The spatial extent as well as projection information for the dataset.

• Term: BandInformation
• URI: http://www.hydroshare.org/terms/BandInformation
• Label: Band Information
• Description: The information to describe the phenomenon represented in each band of the geographic raster data.

• Term: name
• URI: http://www.hydroshare.org/terms/rt_name
• Label: Name
• Description: The name of the band.

• Term: variableName
• URI: http://www.hydroshare.org/terms/variableName
• Label: Variable Name
• Description: The name of the variable represented in the band.

• Term: variableUnit
• URI: http://www.hydroshare.org/terms/variableUnit
• Label: Variable Unit
• Description: The unit of the variable represented in the band.

• Term: method
• URI: http://www.hydroshare.org/terms/rt_method
• Label: Method
• Description: The method used to create the data of the band.

• Term: comment
• URI: http://www.hydroshare.org/terms/rt_comment
• Label: Comment
• Description: Miscellaneous information about the variable.

• Term: CellInformation
• URI: http://www.hydroshare.org/terms/CellInformation
• Label: Cell Information
• Description: The information to describe the cell attributes which applies to all bands.

• Term: rows
• URI: http://www.hydroshare.org/terms/rows
• Label: Rows
• Description: The rows of the cells in each band.

• Term: columns
• URI: http://www.hydroshare.org/terms/columns
• Label: Columns
• Description: The columns of the cells in each band.

• Term: cellSizeXValue
• URI: http://www.hydroshare.org/terms/cellSizeXValue
• Label: Cell Size X Value
• Description: The length of the x direction of a cell in the band.

• Term: cellSizeYValue
• URI: http://www.hydroshare.org/terms/cellSizeYValue
• Label: Cell Size Y Value
• Description: The length of the y direction of a cell in the band.

• Term: cellSizeUnit
• URI: http://www.hydroshare.org/terms/cellSizeUnit
• Label: Cell Size Unit
• Description: The unit defined for the length of the cell size.

• Term: cellDataType
• URI: http://www.hydroshare.org/terms/cellDataType
• Label: Cell Data Type
• Description: The data type of the value represented in each cell.

• Term: noDataValue
• URI: http://www.hydroshare.org/terms/noDtaValue
• Label: No Data Value
• Description: The value used for the condition when there is no actual data value recorded in the cell.

Metadata terms for the Model Program Resource Type

• Term: modelVersion
• URI: http://www.hydroshare.org/terms/modelVersion
• Label: Version
• Description: Model version and/or build number (e.g., SWAT2012 rev. 629)

• Term: modelProgramLanguage
• URI: http://www.hydroshare.org/terms/modelProgramLanguage
• Label: Language
• Description: The programming language(s) that the model was written in.

• Term: modelOperatingSystem
• URI: http://www.hydroshare.org/terms/modelOperatingSystem
• Label: Operating System
• Description: Compatible operating systems to setup and run the model (e.g., Mac OS X version 10.7 and later).

• Term: modelReleaseDate
• URI: http://www.hydroshare.org/terms/modelReleaseDate
• Label: Release Date
• Description: The date that this version of the model was released.

• Term: modelReleaseNotes
• URI: http://www.hydroshare.org/terms/modelReleaseNotes
• Label: Release Notes
• Description: Notes regarding the model release.

• Term: modelWebsite
• URI: http://www.hydroshare.org/terms/modelWebsite
• Label: Website
• Description: A URL to the website maintained by the model developers.

• Term: modelCodeRepository
• URI: http://www.hydroshare.org/terms/modelCodeRepository
• Label: Software Repository
• Description: A URL to the source code repository (e.g., Github, Bitbucket, etc.).

• Term: modelDocumentation
• URI: http://www.hydroshare.org/terms/modelDocumentation
• Label: Documentation
• Description: Uploaded documentation related to the model (e.g., User manual, theoretical manual, reports, etc.).

• Term: modelSoftware
• URI: http://www.hydroshare.org/terms/modelSoftware
• Label: Software
• Description: Uploaded archive containing model software (e.g., utilities software, etc.).

• Term: modelEngine
• URI: http://www.hydroshare.org/terms/modelEngine
• Label: Computational Engine
• Description: Uploaded archive containing the model computational engine (e.g., source code, binary, executable, etc.).

Metadata terms for the Model Instance Resource Type

• Term: ModelOutput
• URI: http://www.hydroshare.org/terms/ModelOutput
• Label: Model Output
• Description: A HydroShare class that encapsulates all the metadata elements related to Model Instance resource output files.

• Term: includesModelOutput
• URI: http://www.hydroshare.org/terms/includesModelOutput
• Label: Includes output
• Description: A boolean value that indicates if the output files are included with the uploaded content.

• Term: ExecutedBy
• URI: http://www.hydroshare.org/terms/ExecutedBy
• Label: Executed By
• Description: A HydroShare class that defines the Model Program that executes the current resource.

• Term: modelProgramName
• URI: http://www.hydroshare.org/terms/modelProgramName
• Label: Model name
• Description: The name of the model that executes the current resource.

• Term: modelProgramIdentifier
• URI: http://www.hydroshare.org/terms/modelProgramIdentifier
• Label: URI
• Description: The HydroShare identifier of the Model Program resource that executes the current resource.

Metadata terms for the SWAT Model Instance Resource Type

• Term: modelObjective
• URI: http://www.hydroshare.org/terms/modelObjective
• Label: Model Objective
• Description: The objective of the Model (e.g. Hydrology, Water quality, BMPs, and Climate / Landuse Change, etc.).

• Term: simulationType
• URI: http://www.hydroshare.org/terms/simulationType
• Label: Simulation Type
• Description: The type of the simulation used (e.g. Normal Simulation, Sensitivity Analysis, and Auto-Calibration).

• Term: ModelInput
• URI: http://www.hydroshare.org/terms/ModelInput
• Label: Model Input
• Description: HydroShare Class that includes all the metadata elements related to Model Instance resource input files.

• Term: warmupPeriodType
• URI: http://www.hydroshare.org/terms/warmupPeriodType
• Label: Warm-up period type
• Description: The warm-up period type.

• Term: warmupPeriodValue
• URI: http://www.hydroshare.org/terms/warmupPeriodValue
• Label: Warm-up period in years
• Description: The numeric value of the warm-up period in years.

• Term: rainfallTimeStepType
• URI: http://www.hydroshare.org/terms/rainfallTimeStepType
• Label: Rainfall time step type
• Description: The type of time step used in the simulation for input rainfall data (e.g. Daily or Sub-hourly).

• Term: rainfallTimeStepValue
• URI: http://www.hydroshare.org/terms/rainfallTimeStepValue
• Label: Rainfall time step value
• Description: The time step value associated with the rainfall data.

• Term: routingTimeStepType
• URI: http://www.hydroshare.org/terms/routingTimeStepType
• Label: Routing time step type
• Description: The type of time step used in the simulation for river routing calculations (e.g. Daily or Hourly).

• Term: routingTimeStepValue
• URI: http://www.hydroshare.org/terms/routingTimeStepValue
• Label: Routing time step value
• Description: The time step value used for the river routing calculations.

• Term: simulationTimeStepType
• URI: http://www.hydroshare.org/terms/simulationTimeStepType
• Label: Simulation time step type
• Description: The type of time step type used for model simulation (e.g. Annual, Monthly, Daily, or Hourly).

• Term: simulationTimeStepValue
• URI: http://www.hydroshare.org/terms/simulationTimeStepValue
• Label: Simulation time step value
• Description: The time step value used for simulation.

• Term: watershedArea
• URI: http://www.hydroshare.org/terms/watershedArea
• Label: Waterhsed area in square kilometers
• Description: The watershed area in Km².

• Term: numberOfSubbasins
• URI: http://www.hydroshare.org/terms/numberOfSubbasins
• Label: Number of subbasins
• Description: The number of the subbasin within the watershed.

• Term: numberOfHRUs
• URI: http://www.hydroshare.org/terms/numberOfHRUs
• Label: Number of HRUs
• Description: The number of the Hydrologic Response Units within the watershed.

• Term: demResolution
• URI: http://www.hydroshare.org/terms/demResolution
• Label: DEM resolution in meters
• Description: The resolution of the Digital Elevation Model in meters.

• Term: demSourceName
• URI: http://www.hydroshare.org/terms/demSourceName
• Label: DEM source name
• Description: The name of the Digital Elevation Model dataset provider.

• Term: demSourceURL
• URI: http://www.hydroshare.org/terms/demSourceURL
• Label: DEM source URL
• Description: The URL of the Digital Elevation Model dataset (if applicable).

• Term: landUseDataSourceName
• URI: http://www.hydroshare.org/terms/landUseDataSourceName
• Label: LandUse data source name
• Description: The name for the Landuse dataset provider.

• Term: landUseDataSourceURL
• URI: http://www.hydroshare.org/terms/landUseDataSourceURL
• Label: LandUse data source URL
• Description: The URL for the Landuse dataset (if applicable).

• Term: soilDataSourceName
• URI: http://www.hydroshare.org/terms/soilDataSourceName
• Label: Soil data source name
• Description: The name for Soil dataset provider.

• Term: soilDataSourceURL
• URI: http://www.hydroshare.org/terms/soilDataSourceURL
• Label: Soil data source URL
• Description: The URL for Soil dataset (if applicable).

• Term: ModelMethod
• URI: http://www.hydroshare.org/terms/ModelMethod
• Label: Model Method
• Description: HydroShare class that includes all the metadata elements related to the model methods used in simulation.

• Term: runoffCalculationMethod
• URI: http://www.hydroshare.org/terms/runoffCalculationMethod
• Label: Runoff calculation method
• Description: The runoff calculation method used.

• Term: flowRoutingMethod
• URI: http://www.hydroshare.org/terms/flowRoutingMethod
• Label: Flow routing method
• Description: The flow routing method used.

• Term: petEstimationMethod
• URI: http://www.hydroshare.org/terms/petEstimationMethod
• Label: PET estimation method
• Description: The Potential EvapoTranspiration estimation method used.

• Term: modelParameter
• URI: http://www.hydroshare.org/terms/modelParameter
• Label: Model Parameter
• Description: The parameters used in the model.

Metadata terms for the MODFLOW Model Instance Resource Type

• Term: StudyArea
• URI: http://www.hydroshare.org/terms/StudyArea
• Label: Study Area
• Description: HydroShare class to describe the main properties of the study area.

• Term: totalLength
• URI: http://www.hydroshare.org/terms/totalLength
• Label: Total length
• Description: The total length of the study area.

• Term: totalWidth
• URI: http://www.hydroshare.org/terms/totalWidth
• Label: Total width
• Description: The total width of the study area.

• Term: maximumElevation
• URI: http://www.hydroshare.org/terms/maximumElevation
• Label: Maximum elevation
• Description: The maximum elevation of the study area.

• Term: minimumElevation
• URI: http://www.hydroshare.org/terms/minimumElevation
• Label: Minimum elevation
• Description: The minimum elevation of the study area.

• Term: GridDimensions
• URI: http://www.hydroshare.org/terms/GridDimensions
• Label: Grid Dimensions
• Description: HydroShare class that includes the properties of the model grid.

• Term: numberOfLayers
• URI: http://www.hydroshare.org/terms/numberOfLayers
• Label: Number of layers
• Description: The number of model grid layers.

• Term: typeOfRows
• URI: http://www.hydroshare.org/terms/typeOfRows
• Label: Type of rows
• Description: If the rows are regular or irregular.

• Term: numberOfRows
• URI: http://www.hydroshare.org/terms/numberOfRows
• Label: Number of rows
• Description: The number of model grid rows.

• Term: typeOfColumns
• URI: http://www.hydroshare.org/terms/typeOfColumns
• Label: Type of columns
• Description: If the columns are regular or irregular.

• Term: numberOfColumns
• URI: http://www.hydroshare.org/terms/numberOfColumns
• Label: Number of columns
• Description: The number of model grid columns.

• Term: StressPeriod
• URI: http://www.hydroshare.org/terms/StressPeriod
• Label: Stress Period
• Description: HydroShare class that includes the information about the stress period.

• Term: stressPeriodType
• URI: http://www.hydroshare.org/terms/stressPeriodType
• Label: Stress period type
• Description: Stress period type (Steady, Transient, steady and Transient).

• Term: steadyStateValue
• URI: http://www.hydroshare.org/terms/steadyStateValue
• Label: Steady state value
• Description: If stress period = steady, length of steady state stress period(s).

• Term: transientStateValueType
• URI: http://www.hydroshare.org/terms/transientStateValueType
• Label: Transient state value type
• Description: Value type if stress period type is Transient or steady and transient (hourly, daily, monthly, yearly, other).

• Term: transientStateValue
• URI: http://www.hydroshare.org/terms/transientStateValue
• Label: Transient state value
• Description: If stress period type is transient or steady and transient, length of transient stress period(s).

• Term: GroundWaterFlow
• URI: http://www.hydroshare.org/terms/GroundWaterFlow
• Label: GroundWater Flow
• Description: HydroShare class that includes the information about groundwater flow.

• Term: flowPackage
• URI: http://www.hydroshare.org/terms/flowPackage
• Label: Flow package
• Description: Groundwater flow package used in the model.

• Term: groundwaterFlowParameter
• URI: http://www.hydroshare.org/terms/groundwaterFlowParameter
• Label: Groundwater flow parameter
• Description: Indicate which of the following parameter is used in the simulation (Hydraulic Conductivity or Transmissivity).

• Term: BoundaryCondition
• URI: http://www.hydroshare.org/terms/BoundaryCondition
• Label: Boundary Condition
• Description: HydroShare class that includes the information about the boundary condition.

• Term: specifiedHeadBoundaryPackages
• URI: http://www.hydroshare.org/terms/specifiedHeadBoundaryPackages
• Label: Specified head boundary packages
• Description: Specified head boundary package/s used in the simulation.

• Term: specifiedFluxBoundaryPackages
• URI: http://www.hydroshare.org/terms/specifiedFluxBoundaryPackages
• Label: Specified flux boundary packages
• Description: Specified flux boundary package/s used in the simulation.

• Term: headDependentFluxBoundaryPackages
• URI: http://www.hydroshare.org/terms/headDependentFluxBoundaryPackages
• Label: Head dependent flux boundary packages
• Description: Head dependent flux boundary package/s used in the simulation.

• Term: ModelCalibration
• URI: http://www.hydroshare.org/terms/ModelCalibration
• Label: Model Calibration
• Description: HydroShare class to include the main aspects of the model calibration.

• Term: calibratedParameter
• URI: http://www.hydroshare.org/terms/calibratedParameter
• Label: Calibrated parameter
• Description: Parameters estimated during model calibration.

• Term: observationType
• URI: http://www.hydroshare.org/terms/observationType
• Label: Observation type
• Description: Data used to constrain the model calibration (heads, stream flow, drawdown).

• Term: observationProcessPackage
• URI: http://www.hydroshare.org/terms/observationProcessPackage
• Label: Observation process package
• Description: Observation process package used in the simulation.

• Term: calibrationMethod
• URI: http://www.hydroshare.org/terms/calibrationMethod
• Label: Calibration method
• Description: Methods used for calibration (software, manual calibration..etc.).

• Term: inputType
• URI: http://www.hydroshare.org/terms/inputType
• Label: Input type
• Description: The type of the input data.

• Term: inputSourceName
• URI: http://www.hydroshare.org/terms/inputSourceName
• Label: Input source name
• Description: The input data source name.

• Term: inputSourceURL
• URI: http://www.hydroshare.org/terms/inputSourceURL
• Label: Input source URL
• Description: The input data source website.

• Term: modelSolver
• URI: http://www.hydroshare.org/terms/modelSolver
• Label: Model solver
• Description: Used solver for the simulation.

• Term: outputControlPackage
• URI: http://www.hydroshare.org/terms/outputControlPackage
• Label: Output control package
• Description: Output control package used in the simulation.

• Term: subsidencePackage
• URI: http://www.hydroshare.org/terms/subsidencePackage
• Label: Subsidence package
• Description: Subsidence package used in the simulation.

Metadata terms for the Web App Resource Type

• Term: AppURLPattern
• URI: http://www.hydroshare.org/terms/AppURLPattern
• Label: App-launching URL Pattern
• Description: In most cases, an app will have been programmed to expect certain parameters in its App-launching URL which send the app important information, such as which HydroShare resource to retrieve and process. HydroShare provides predefined parameters to achieve this. These predefined parameters can be appended to your App-launching URL. They will be dynamically replaced at run-time when a user launches your app from a resource landing page. This approach gives you greater flexibility when customizing App-launching URL.
  Currently, HydroShare supports the following parameters:
  • Keys available in all launching patterns
  • ${HS_RES_ID}: Resource ID
  • ${HS_RES_TYPE}: Resource Type
  • ${HS_USR_NAME}: HydroShare username
  • Keys only available within App-launching URL Pattern
  • ${HS_FILE_NAME}: Fullname of a file in a resource. For example, full name of the '.nc' file in a NetCDF resource or full name of the '.vrt' file in a raster resource.
  • Keys only available within App-launching File Level URL Pattern
  • ${HS_FILE_PATH}: Path of a file in HydroShare
  • Keys only available within App-launching Aggregation Level URL Pattern
  • ${HS_AGG_PATH}: Path of an aggregation in HydroShare
  • ${HS_MAIN_FILE}: The main file name of an aggregation
  An example:
  http://www.my-app-website.org/app_1/?res_id=${HS_RES_ID}.
  HydroShare will replace ${HS_RES_ID} with the real resource id.

• Term: SupportedResourceType
• URI: http://www.hydroshare.org/terms/SupportedResourceType
• Label: Supported Resource Type
• Description: Names of applicable date resource type.

• Term: WebAppVersion
• URI: http://www.hydroshare.org/terms/WebAppVersion
• Label: Version
• Description: Web App Version.

Metadata terms for the Script Resource Type

• Term: scriptLanguage
• URI: http://www.hydroshare.org/terms/scriptLanguage
• Label: Programming Language
• Description: The programming language that the script is written in.

• Term: languageVersion
• URI: http://www.hydroshare.org/terms/languageVersion
• Label: Programming Language Version
• Description: The version of the language that the script is written in.

• Term: scriptVersion
• URI: http://www.hydroshare.org/terms/scriptVersion
• Label: Script Version
• Description: The version of the script.

• Term: scriptDependencies
• URI: http://www.hydroshare.org/terms/scriptDependencies
• Label: Script Dependencies
• Description: The libraries/modules that the script depends on to execute.

• Term: scriptReleaseDate
• URI: http://www.hydroshare.org/terms/scriptReleaseDate
• Label: Release Date
• Description: The date that this version of the script was released.

• Term: scriptCodeRepository
• URI: http://www.hydroshare.org/terms/scriptCodeRepository
• Label: Script Repository
• Description: The URL to a respository where the script is also stored.

Metadata terms for the Composite Resource Type

A Composite resource is a resource that can include multiple files without file format limitations. However, it is also capable of containing typed aggregations of files (e.g., a geographic feature aggregation stored as an ESRI shapefile). The Composite resource is designed to support metadata and data functions at both the aggregation level and resource level to better support data management in HydroShare. Each aggregation contained within a Composite resource may be annotated with general metadata that apply specifically to the aggregation. Aggregations may also have metadata specific to the aggregation type and additional data functions established for that type (e.g., metadata extraction from TIFF or NetCDF file). The resource level metadata for a Composite resource is the same as metadata of the generic resource type.

The following terms define the types of aggregations that can be added to a Composite Resource:

• Term: SingleFileAggregation
• URI: http://www.hydroshare.org/terms/SingleFileAggregation
• Label: Single File Aggregation
• Description: An aggregation added to a Composite resource consisting of a single content file to which aggregation-level metadata have been added.

• Term: GeographicFeatureAggregation
• URI: http://www.hydroshare.org/terms/GeographicFeatureAggregation
• Label: Geographic Feature Aggregation
• Description: An aggregation added to a Composite resource consisting of the multiple content files that make up an ESRI shapefile containing a geographic feature dataset and to which aggregation-level metadata have been added.

• Term: GeographicRasterAggregation
• URI: http://www.hydroshare.org/terms/GeographicRasterAggregation
• Label: Geographic Raster Aggregation
• Description: An aggregation added to a Composite resource consisting of the multiple content files that make up a geographic raster dataset to which aggregation-level metadata have been added. Rasters may have multiple files and multiple bands and are stored in HydroShare as GeoTIFF files.

• Term: MultidimensionalAggregation
• URI: http://www.hydroshare.org/terms/MultidimensionalAggregation
• Label: Multidimensional Aggregation
• Description: An aggregation added to a Composite resource consisting of a Network Common Data Form (NetCDF) file that makes up a multidimensional space-time dataset to which aggregation-level metadata have been added.

• Term: TimeSeriesAggregation
• URI: http://www.hydroshare.org/terms/TimeSeriesAggregation
• Label: TimeSeriesAggregation
• Description: An aggregation added to a Composite resource consisting of one or more time series datasets to which aggregation-level metadata have been added. Time series datasets in HydroShare consist of sequences of individual data values that are ordered in time to record the changing trend of a certain phenomenon. They are stored in HydroShare using ODM2 SQLite database files.

• Term: ReferencedTimeSeriesAggregation
• URI: http://www.hydroshare.org/terms/ReferencedTimeSeriesAggregation
• Label: Referenced Time Series Aggregation
• Description: An aggregation added to a Composite resource consisting of references to specific time series datasets hosted on an external web service to which aggregation-level metadata have been added.

• Term: FileSetAggregation
• URI: http://www.hydroshare.org/terms/FileSetAggregation
• Label: File Set Aggregation
• Description: An aggregation added to a Composite resource consisting of an arbitrary collection of files that are logically grouped together as an aggregation and to which aggregation-level metadata have been added. There may be any number of files in the aggregation, and files may be of any type.

Metadata terms specific to the aggregation type are the same as those used to describe the corresponding resource type listed above.