EnergyResearchSoftware

Creation date: 2025-02-18
Last updated: 2025-03-11
License: http://spdx.org/licenses/CC0-1.0
Creator: Stephan Ferenz

Table of Contents


Diagrams

schema:Organizationschema:identifier : xsd:anyURIschema:legalName : xsd:string [0..1]ersmeta:EnergyComponentschema:identifier : xsd:string [0..1]schema:name : xsd:string [0..1]ersmeta:levelOfDetail [0..1]oeo:OEO_00000407schema:Personschema:identifier : xsd:anyURI [0..1]schema:givenName : xsd:string [1..1]schema:familyName : xsd:string [1..1]schema:email : xsd:stringschema:roleNameersmeta:CommunityInteractionschema:additionalType [0..1]schema:url : xsd:string [0..1]schema:CreativeWorkschema:identifier : xsd:anyURIschema:name : xsd:stringschema:Reviewschema:abstract : xsd:string [0..1]schema:reviewBody : xsd:string [0..1]schema:reviewAspect : xsd:string [0..1]schema:SoftwareApplicationschema:identifier : xsd:anyURIschema:name : xsd:stringersmeta:Validationschema:additionalType [0..1]schema:url : xsd:anyURI [0..1]ersmeta:similarityOfResults : xsd:float [0..1]ersmeta:Exampleschema:additionalType [0..1]schema:name : xsd:string [0..1]schema:url : xsd:anyURI [0..1]ersmeta:Interfaceschema:identifier : xsd:anyURI [0..1]schema:description : xsd:string [0..1]oeo:OEO_00000516 : xsd:stringschema:encodingFormatersmeta:required : xsd:boolean [0..1]ersmeta:usedStandard : xsd:stringokn:hasExample : xsd:stringersmeta:OptimizationToolm4i:implementsMethod : xsd:stringschema:featureList : xsd:stringoeo:OEO_00000392 : xsd:stringersmeta:problemType : xsd:string [0..1]schema:MonetaryAmountschema:value : xsd:floatschema:currency : xsd:stringersmeta:TestCollectionschema:collectionSize : xsd:integer [0..1]schema:url : xsd:stringschema:ScholarlyArticleschema:identifier : xsd:anyURI [0..1]ersmeta:EnergyResearchSoftwareschema:name : xsd:string [1..1]okn:hasShortName : xsd:string [0..1]schema:identifier : xsd:anyURI [0..1]schema:thumbnailUrl : xsd:anyURI [0..1]schema:softwareVersion : xsd:string [1..1]schema:programmingLanguage : https://www.wikidata.org/wiki/Q9143 [1..*]schema:inLanguage : xsd:stringschema:abstract : xsd:string [0..1]schema:description : xsd:string [1..1]schema:keywords : xsd:string [1..*]schema:image : xsd:anyURIschema:applicationCategoryschema:applicationSubCategoryersmeta:softwareType [1..1]prov:hadRoleschema:url : xsd:anyURIcodemeta:developmentStatus [1..*]ersmeta:developerStructureersmeta:cycleOfUpdatescodemeta:issueTracker : xsd:anyURIschema:isAccessibleForFree : xsd:booleanschema:dateCreated : xsd:date [1..1]schema:dateModified : xsd:date [0..1]schema:countryOfOrigin : xsd:stringschema:downloadUrl : xsd:anyURI [1..1]schema:codeRepository : xsd:stringokn:hasDocumentation : xsd:anyURI [0..1]codemeta:readme : xsd:anyURI [0..1]codemeta:buildInstruction : xsd:anyURI [0..1]ontosoft:hasSoftwareSupport : xsd:boolean [0..1]ersmeta:requiredTrainingPeriod : xsd:string [0..1]ersmeta:compatibleHardware : xsd:stringokn:hasPurpose : xsd:stringm4i:implementsMethod : xsd:stringoeo:OEO_00000505 : oeo:OEO_00000367okn:hasAssumption : xsd:stringersmeta:useCase : xsd:stringontosoft:hasUseLimitations : xsd:stringokn:hasParameter : xsd:stringschema:featureList : xsd:stringoeo:OEO_00000516schema:temporalCoverage [0..1]ersmeta:stationaryVsTransient [0..1]oeo:OEO_00000515 : xsd:stringersmeta:dimensionsersmeta:spatialScope : xsd:string [0..1]schema:spatialCoverage : xsd:stringersmeta:supportedVoltageLevelschema:availableOnDeviceschema:timeRequired : xsd:floatschema:processorRequirements : xsd:string [0..1]schema:memoryRequirements : xsd:string [0..1]schema:storageRequirements : xsd:string [0..1]ersmeta:realtimeCapabilityersmeta:parallelizationCapability : xsd:boolean [0..1]schema:targetProduct : xsd:stringschema:operatingSystem : https://www.wikidata.org/wiki/Q9135schema:softwareRequirements : xsd:stringschema:fileSize : xsd:string [0..1]schema:schemaVersion : xsd:string [1..1]schema:sdPublisher : xsd:string [1..1]schema:dataSetschema:Grantschema:name : xsd:string [0..1]schema:identifier : xsd:string [0..1]schema:additionalType [0..1]ersmeta:usedOptimizationersmeta:validationersmeta:communityInteractionsschema:reviewersmeta:energyComponentschema:contributor [1..*]schema:authorschema:maintainer [0..1]schema:copyrightHolderschema:sourceOrganizationschema:estimatedCost [0..1]okn:hasExamplecodemeta:referencePublicationokn:citation [0..1]ontosoft:usedInPublicationontosoft:hasRelevantDataSourcesersmeta:usedDataersmeta:testsobo:RO_0002234obo:RO_0002233schema:fundingoeo:OEO_00000521ontosoft:hasCompatibleSoftwareschema:license [1..*]schema:sdLicense [1..*]schema:funder
Click diagram to navigate to corresponding section | View as PNG

Description

This metadata schema includes general metadata elements for research software in the energy domain.

Model documentation

EnergyResearchSoftware

https://nfdi4energy.github.io/ERSmeta/#ersmeta:EnergyResearchSoftware

This is the main element to describe energy research software.

ersmeta:EnergyResearchSoftwareschema:name : xsd:string [1..1]okn:hasShortName : xsd:string [0..1]schema:identifier : xsd:anyURI [0..1]schema:thumbnailUrl : xsd:anyURI [0..1]schema:softwareVersion : xsd:string [1..1]schema:inLanguage : xsd:stringschema:abstract : xsd:string [0..1]schema:description : xsd:string [1..1]schema:keywords : xsd:string [1..*]schema:image : xsd:anyURIschema:applicationCategoryschema:applicationSubCategoryersmeta:softwareType [1..1]prov:hadRoleschema:url : xsd:anyURIcodemeta:developmentStatus [1..*]ersmeta:developerStructureersmeta:cycleOfUpdatescodemeta:issueTracker : xsd:anyURIschema:isAccessibleForFree : xsd:booleanschema:dateCreated : xsd:date [1..1]schema:dateModified : xsd:date [0..1]schema:countryOfOrigin : xsd:stringschema:downloadUrl : xsd:anyURI [1..1]schema:codeRepository : xsd:stringokn:hasDocumentation : xsd:anyURI [0..1]codemeta:readme : xsd:anyURI [0..1]codemeta:buildInstruction : xsd:anyURI [0..1]ontosoft:hasSoftwareSupport : xsd:boolean [0..1]ersmeta:requiredTrainingPeriod : xsd:string [0..1]ersmeta:compatibleHardware : xsd:stringokn:hasPurpose : xsd:stringm4i:implementsMethod : xsd:stringokn:hasAssumption : xsd:stringersmeta:useCase : xsd:stringontosoft:hasUseLimitations : xsd:stringokn:hasParameter : xsd:stringschema:featureList : xsd:stringoeo:OEO_00000516schema:temporalCoverage [0..1]ersmeta:stationaryVsTransient [0..1]oeo:OEO_00000515 : xsd:stringersmeta:dimensionsersmeta:spatialScope : xsd:string [0..1]schema:spatialCoverage : xsd:stringersmeta:supportedVoltageLevelschema:availableOnDeviceschema:timeRequired : xsd:floatschema:processorRequirements : xsd:string [0..1]schema:memoryRequirements : xsd:string [0..1]schema:storageRequirements : xsd:string [0..1]ersmeta:realtimeCapabilityersmeta:parallelizationCapability : xsd:boolean [0..1]schema:targetProduct : xsd:stringschema:softwareRequirements : xsd:stringschema:fileSize : xsd:string [0..1]schema:schemaVersion : xsd:string [1..1]schema:sdPublisher : xsd:string [1..1]ersmeta:OptimizationToolersmeta:Validationersmeta:CommunityInteractionhttps://www.wikidata.org/wiki/Q9143schema:Reviewersmeta:EnergyComponenthttps://www.wikidata.org/wiki/Q9135schema:Personschema:Organizationschema:MonetaryAmountersmeta:Exampleschema:ScholarlyArticleoeo:OEO_00000367schema:dataSetersmeta:TestCollectionersmeta:Interfaceschema:Grantoeo:OEO_00000407schema:SoftwareApplicationschema:CreativeWorkersmeta:usedOptimizationersmeta:validationersmeta:communityInteractionsschema:programmingLanguage [1..*]schema:reviewersmeta:energyComponentschema:operatingSystemschema:contributor [1..*]schema:authorschema:maintainer [0..1]schema:copyrightHolderschema:sourceOrganizationschema:estimatedCost [0..1]okn:hasExamplecodemeta:referencePublicationokn:citation [0..1]ontosoft:usedInPublicationoeo:OEO_00000505ontosoft:hasRelevantDataSourcesersmeta:usedDataersmeta:testsobo:RO_0002234obo:RO_0002233schema:fundingoeo:OEO_00000521ontosoft:hasCompatibleSoftwareschema:license [1..*]schema:sdLicense [1..*]
Click diagram to navigate to corresponding section | View as PNG
Property name URI Expected value Card. Description
name schema:name xsd:string
1..1
Name of the software.
acronym okn:hasShortName xsd:string
0..1
Abbreviation of the software name.
identifier schema:identifier xsd:anyURI
0..1
The identifier property represents any kind of identifier for any kind of Thing, such as DOI, ISBNs, GTIN codes, UUIDs etc.
logo schema:thumbnailUrl xsd:anyURI
0..1
Link to the logo of the software.
softwareVersion schema:softwareVersion xsd:string
1..1
Version of the software instance as used by the developers.
programmingLanguage schema:programmingLanguage https://www.wikidata.org/wiki/Q9143
1..*
The computer programming language in which the software is written.
inLanguage schema:inLanguage xsd:string
0..*
Language used within the software (e.g. variables, documentation). Standard: IETF (BCP47)
abstract schema:abstract xsd:string
0..1
A one-line summary of what the software does.
description schema:description xsd:string
1..1
A description of the software. Max 200 words.
keywords schema:keywords xsd:string
1..*
Keywords or tags used to describe this software.
graphicalAbstract schema:image xsd:anyURI
0..*
Graphical overview on the functionality of the software.
domain schema:applicationCategory

Social Science, Economics, Jurisprudence, Chemistry, Physics, Mathematics, Geosciences, Production Technology, Mechanics and Constructive Mechanical Engineering, Process Engineering, Technical Chemistry, Fluid Mechanics, Technical Thermodynamics and Thermal Energy Engineering, Materials Engineering, Materials Science, System Engineering; Electrical Engineering and Information Technology, Computer Science, Construction Engineering and Architecture

0..*
Research domain for which the software was written.
category schema:applicationSubCategory

Research on components, Control strategies for energy systems, Grid planning, Transition of the energy system,, Energy markets, Other

0..*
Research category for which the software was written.
softwareType ersmeta:softwareType

GUI-framework, Command-line tool, Database portal, Desktop application, Library, Plug-in, Script, Web application, Web API, Web service, Workbench, Workflow

1..1
Type of software application, e.g. 'script'.
roleInResearch prov:hadRole

Modeling and Simulation, Numerical Modeling, Agent-based Modeling, Data Analytics, Observation Data Analytics, Simulation Data Analytics, Statistical Analysis, Machine Learning, Integrative Analysis, Data Assimilation, Decision Analysis, Scientific Visualization, Proof-of-Concept Software, Research Infrastructure Software, Control and Monitoring Software (Embedded, Web-based, Native), Data Collection, Pipelines/Workflows, Libraries, Laboratiry Notebooks, Data Management, Software Management, Collaboration Software

0..*
Kind of tasks that the software tasks over in research.
url schema:url xsd:anyURI
0..*
Homepage of the tool. URL of the item.
developmentStatus codemeta:developmentStatus

Concept, WIP, Suspended, Abandoned, Active, Inactive, Unsupported, Moved

1..*
Description of development status, e.g. Active, inactive, suspended. See repostatus.org
developerStructure ersmeta:developerStructure

Individual Researcher, Local Research Group, Project Group, Community (Open Source Resarch Software, Closed Source Research Software, Research Software as a Service), Contractor (Open Source Resarch Software, Closed Source Research Software, Research Software as a Service)

0..*
Structure of the development team.
cycleOfUpdates ersmeta:cycleOfUpdates

Weekly, Monthly, Quarterly, Irregularly

0..*
How often is the software updated?
issueTracker codemeta:issueTracker xsd:anyURI
0..*
Link to software bug reporting or issue tracking system
referencePublication codemeta:referencePublication ScholarlyArticle
0..*
Any academic publication which describes the software.
preferredCitation okn:citation ScholarlyArticle
0..1
A reference to another work that should be cited instead of the software or dataset itself. Note that the principles of  "software citation" and "data citation" require that software should be cited on the same basis as any other research product such as a paper or a book. Adding a different preferred citation may result in a violation of the respective primary principle, "Importance", when others cite this work.
license schema:license CreativeWork
1..*
A license document that applies to this software.
copyrightHolder schema:copyrightHolder Organization
0..*
The party holding the legal copyright to the CreativeWork.
isAccessibleForFree schema:isAccessibleForFree xsd:boolean
0..*
A flag to signal that the software is accessible for free.
estimatedCost schema:estimatedCost MonetaryAmount
0..1
Typical cost for licensing the software, if available.
dateCreated schema:dateCreated xsd:date
1..1
The date on which the software was initially created.
dateModified schema:dateModified xsd:date
0..1
The date on which the software was most recently modified.
contributor schema:contributor Person
1..*
A person who has contributed to the software.
author schema:author Person
0..*
A person who has authored the software.
maintainer schema:maintainer Person
0..1
Individual responsible for maintaining the software.
sourceOrganization schema:sourceOrganization Organization
0..*
Institution which developed the software.
countryOfOrigin schema:countryOfOrigin xsd:string
0..*
Country where the software was developed. Country codes as defined by ISO 3166-1 alpha-2 should be used.
funding schema:funding schema:Grant
0..*
Information on the funding which was used to develop the software.
downloadUrl schema:downloadUrl xsd:anyURI
1..1
If the file can be downloaded, URL to download the binary.
codeRepository schema:codeRepository xsd:string
0..*
Link to the repository where the un-compiled, human readable code and related code is located (SVN, GitHub, CodePlex, institutional GitLab instance, etc.).
documentation okn:hasDocumentation xsd:anyURI
0..1
Link to the documentation describing the code and is usful for developers.
readme codemeta:readme xsd:anyURI
0..1
Link to the documentation describing the code and is usful for developers.
buildInstruction codemeta:buildInstruction xsd:anyURI
0..1
Link to installation instructions/documentation.
supportGiven ontosoft:hasSoftwareSupport xsd:boolean
0..1
Is support for the software provided?
requiredTrainingPeriod ersmeta:requiredTrainingPeriod xsd:string
0..1
How long would a researcher need to be able to use the software?
example okn:hasExample Example
0..*
Code examples for using the software.
communityInteractions ersmeta:communityInteractions CommunityInteraction
0..*
Ways how the software developers interact with the software users (community).
usedInPublication ontosoft:usedInPublication ScholarlyArticle
0..*
A publication which uses the software for its research.
output obo:RO_0002234 Interface
0..*
Description of the output functions of the software (e.g., APIs)
input obo:RO_0002233 Interface
0..*
Description of the input functions of the software (e.g., APIs)
compatibleSoftware ontosoft:hasCompatibleSoftware SoftwareApplication
0..*
A software which can directly be used with the software without further changes.
compatibleHardware ersmeta:compatibleHardware xsd:string
0..*
Hardware which is compatible to this software (e.g., in labs).
compatibleData ontosoft:hasRelevantDataSources schema:dataSet
0..*
Data which is compatible to this software.
usedData ersmeta:usedData schema:dataSet
0..*
Data that is directly used by the provided software
purpose okn:hasPurpose xsd:string
0..*
A general goal/purpose of the software.
implementsMethod m4i:implementsMethod xsd:string
0..*
An used method in the software.
coversSector oeo:OEO_00000505 oeo:OEO_00000367
0..*
A supported sector of the software. A sector is generically dependent continuant that is a subdivision of a system.
technology oeo:OEO_00000521 oeo:OEO_00000407
0..*
A supported energy technology of the software.
assumption okn:hasAssumption xsd:string
0..*
A required assumption of the software.
useCase ersmeta:useCase xsd:string
0..*
Other supported use case, e.g., a research question which can be answered with the software besides the main goal.
energyComponent ersmeta:energyComponent EnergyComponent
0..*
A component of the energy system included in the software.
limitation ontosoft:hasUseLimitations xsd:string
0..*
A limitation of the software.
parameter okn:hasParameter xsd:string
0..*
A relevant internal parameter of the software.
featureList schema:featureList xsd:string
0..*
A feature of the software.
hasTemporalResolution oeo:OEO_00000516

annual, monthly, weekly, daily, hourly, quarter-hourly, minutely, secondly, unlimited, other, none

0..*
Supported temporal resolution of the software. Temporal resolution is the resolution that indicates time-dependent the level of detail.
temporalCoverage schema:temporalCoverage

Short term (<= 5 years), Medium term (>5-<15), Long term (>=15), Other

0..1
Time scope the software was developed for (e.g. 2010, 2050).
stationaryVsTransient ersmeta:stationaryVsTransient

Stationary, Transient

0..1
Does the software support stationary or transient effects?
hasSpatialResolution oeo:OEO_00000515 xsd:string
0..*
Supported spatial resolution of the software. Spatial resolution is the resolution that indicates the geographical level of detail.
dimensions ersmeta:dimensions

1D, 2D, 3D

0..*
Supported dimensions of the software.
spatialScope ersmeta:spatialScope xsd:string
0..1
Geo scope the software was developed for (e.g., microgrid, Germany, Europe).
spatialCoverage schema:spatialCoverage xsd:string
0..*
Regions covered by the model. Leave this blank if the model and data are not limited to a specific region. Examples include: USA, Canada, Germany, western Europe.
supportedVoltageLevel ersmeta:supportedVoltageLevel

Low Voltage, Medium Voltage, High Voltage,

0..*
Supported voltage level of the software.
usedOptimization ersmeta:usedOptimization OptimizationTool
0..*
Information on an optimization included in the software.
review schema:review Review
0..*
A review of the software.
tests ersmeta:tests TestCollection
0..*
Information on the tests of the software.
validation ersmeta:validation Validation
0..*
Information on validations done for the software. Validation refers to whether the software produces results that correspond to real-world properties.
typicalHardware schema:availableOnDevice

Laptop, Desktop Computer/Work station, HPC

0..*
Typical minimal hardware which is required to run the software.
typicalExcecutionTime schema:timeRequired xsd:float
0..*
Typical execution time of the software.
processorRequirements schema:processorRequirements xsd:string
0..1
Processor architecture required to run the application (e.g. IA64).
memoryRequirements schema:memoryRequirements xsd:string
0..1
Minimum memory requirements.
storageRequirements schema:storageRequirements xsd:string
0..1
Storage requirements (free space required).
realtimeCapablity ersmeta:realtimeCapability

Hard, Firm, Soft, None

0..*
What kind of realtime simulations are supported by the software?
parallelizationCapability ersmeta:parallelizationCapability xsd:boolean
0..1
Does the software support parallization?
targetProduct schema:targetProduct xsd:string
0..*
Target programming enviroments to which the code applies. If applies to several versions, just the product name can be used.
operatingSystem schema:operatingSystem https://www.wikidata.org/wiki/Q9135
0..*
softwareRequirements schema:softwareRequirements xsd:string
0..*
Required software dependencies.
fileSize schema:fileSize xsd:string
0..1
Size of the application / package (e.g. 18MB). In the absence of a unit (MB, KB etc.), KB will be assumed.
schemaVersion schema:schemaVersion xsd:string
1..1
The type and version number of the metadata.
sdLicense schema:sdLicense CreativeWork
1..*
The license of the provided metadata.
sdPublisher schema:sdPublisher xsd:string
1..1
Indicates the party responsible for generating and publishing the current structured data markup, typically in cases where the structured data is derived automatically from existing published content but published on a different site. For example, student projects and open data initiatives often re-publish existing content with more explicitly structured metadata. The sdPublisher property helps make such practices more explicit.

CommunityInteraction

https://nfdi4energy.github.io/ERSmeta/#ersmeta:CommunityInteraction

Interaction with the community of the research software.

Property name URI Expected value Card. Description
additionalType schema:additionalType

Mailinglist, Issues, In-person meet-ups, Forum, Online meetings, Github discussions

0..1
Type of the interaction.
url schema:url xsd:string
0..1
Link to further information on the community interaction.

SoftwareApplication

http://schema.org/SoftwareApplication

A software application.

Property name URI Expected value Card. Description
identifier schema:identifier xsd:anyURI
0..*
The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc.,
name schema:name xsd:string
0..*
Name of the compatible software.

CreativeWork

http://schema.org/CreativeWork

The most generic kind of creative work, including books, movies, photographs, software programs, etc.

Property name URI Expected value Card. Description
identifier schema:identifier xsd:anyURI
0..*
The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc.
name schema:name xsd:string
0..*
The name of the item.

DataSet

http://schema.org/DataSet

A body of structured information describing some topic(s) of interest.

Property name URI Expected value Card. Description
identifier schema:identifier xsd:string
0..1
The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc.
encodingFormat schema:encodingFormat

csv, xlsx, xml, mdf5, JSON, YAML, binary, Pandas, DataFrame/Serie, Python dict, db, mat, other

0..*
Format of the dataset.
url schema:url xsd:string
0..*
Link to the dataset.

EnergyComponent

https://nfdi4energy.github.io/ERSmeta/#ersmeta:EnergyComponent

An energy component modelled within a simulation software

Click diagram to navigate to corresponding section | View as PNG
Property name URI Expected value Card. Description
identifier schema:identifier xsd:string
0..1
The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as Textual strings or as URL (URI) links. See background notes for more details.
name schema:name xsd:string
0..1
Name of the component.
additionalType schema:additionalType oeo:OEO_00000407
0..1
Type of the component, e.g., pv
levelOfDetail ersmeta:levelOfDetail

low (simple timeseries), middle (linear equations with some parameters), high (nonlinear equations with a high number of parameters)

0..1
Level of detail of the component.

Example

https://nfdi4energy.github.io/ERSmeta/#ersmeta:Example

Example for a software usage

Property name URI Expected value Card. Description
additionalType schema:additionalType

Minimal, Long, Paper, Test

0..1
Type of the example.
name schema:name xsd:string
0..1
Name of the example.
url schema:url xsd:anyURI
0..1
Link to the example.

schema:Grant

http://schema.org/Grant

A grant, typically financial or otherwise quantifiable, of resources. Typically a funder sponsors some MonetaryAmount to an Organization or Person, sometimes not necessarily via a dedicated or long-lived Project, resulting in one or more outputs, or fundedItems. For financial sponsorship, indicate the funder of a MonetaryGrant. For non-financial support, indicate sponsor of Grants of resources (e.g. office space). Grants support activities directed towards some agreed collective goals, often but not always organized as Projects. Long-lived projects are sometimes sponsored by a variety of grants over time, but it is also common for a project to be associated with a single grant. The amount of a Grant is represented using amount as a MonetaryAmount.

Property name URI Expected value Card. Description
projectName schema:name xsd:string
0..1
Name of the project during which the software was developed.
grantNo schema:identifier xsd:string
0..1
An identifying grant number, in case of a publicly funded project, this number is assigned by the funding agency.
funder schema:funder Organization
0..*
A organization that supports (sponsors) something through some kind of financial contribution.

Interface

https://nfdi4energy.github.io/ERSmeta/#ersmeta:Interface

An interface of a software

Property name URI Expected value Card. Description
identifier schema:identifier xsd:anyURI
0..1
The identifier property represents any kind of identifier for any kind of Thing, such as ISBNs, GTIN codes, UUIDs etc. Schema.org provides dedicated properties for representing many of these, either as Textual strings or as URL (URI) links. See background notes for more details.
description schema:description xsd:string
0..1
Description of the content exchanged via the interface.
hasTemporalResolution oeo:OEO_00000516 xsd:string
0..*
Description on the required temporal resolution for the interface.
encodingFormat schema:encodingFormat

csv, xlsx, xml, txt, mdf5, JSON, YAML, binary, Pandas, DataFrame/Serie, Python dict, db, mat, other

0..*
Description of the allowed encoding format of the interface, e.g., csv
required ersmeta:required xsd:boolean
0..1
Is it required to provide input to the interface?
usedStandard ersmeta:usedStandard xsd:string
0..*
Supported standards of the API.
example okn:hasExample xsd:string
0..*
Example for the interface.

MonetaryAmount

http://schema.org/MonetaryAmount

A monetary value or range. This type can be used to describe an amount of money such as $50 USD, or a range as in describing a bank account being suitable for a balance between £1,000 and £1,000,000 GBP, or the value of a salary, etc. It is recommended to use PriceSpecification Types to describe the price of an Offer, Invoice, etc.

Property name URI Expected value Card. Description
value schema:value xsd:float
0..*
The value of the estimatedCost.
currency schema:currency xsd:string
0..*
The currency in which the monetary amount is expressed. Use standard formats: ISO 4217 currency format, e.g. USD; Ticker symbol for cryptocurrencies, e.g. BTC; well known names for Local Exchange Trading Systems (LETS) and other currency types, e.g. Ithaca HOUR.

OptimizationTool

https://nfdi4energy.github.io/ERSmeta/#ersmeta:OptimizationTool

A tool used for optimization

Property name URI Expected value Card. Description
implementsMethod m4i:implementsMethod xsd:string
0..*
Method of the optimization.
featureList schema:featureList xsd:string
0..*
Features of the optimization.
solver oeo:OEO_00000392 xsd:string
0..*
Used solver for the optimization.
problemType ersmeta:problemType xsd:string
0..1
Problem class of the optimization.

Organization

http://schema.org/Organization

An organization such as a school, NGO, corporation, club, etc.

Property name URI Expected value Card. Description
identifier schema:identifier xsd:anyURI
0..*
URL identifier, ideally a ROR for institutions.
legalName schema:legalName xsd:string
0..1
The official name of the organization, e.g. the registered company name.

Person

http://schema.org/Person

A person (alive, dead, undead, or fictional).

Property name URI Expected value Card. Description
identifier schema:identifier xsd:anyURI
0..1
URL identifier, ideally an ORCID ID for individuals, a FundRef ID for funders.
givenName schema:givenName xsd:string
1..1
Given name. In the U.S., the first name of a Person. This can be used along with familyName instead of the name property.
familyName schema:familyName xsd:string
1..1
Family name. In the U.S., the last name of an Person. This can be used along with givenName instead of the name property.
email schema:email xsd:string
0..*
Email address.
roleName schema:roleName

Design, Coding, Testing, Debugging, Architecture, Support, Maintenance, Documentation, Management

0..*
Detailed role of a person.

Review

http://schema.org/Review

A review of a software.

Property name URI Expected value Card. Description
abstract schema:abstract xsd:string
0..1
A review of the source code.
reviewBody schema:reviewBody xsd:string
0..1
The actual body of the review.
reviewAspect schema:reviewAspect xsd:string
0..1
This Review is relevant to this part or facet of the object being review.

ScholarlyArticle

http://schema.org/ScholarlyArticle

A scholarly article.

Click diagram to navigate to corresponding section | View as PNG
Property name URI Expected value Card. Description
identifier schema:identifier xsd:anyURI
0..1
URL identifier, ideally a DOI for a publication.

TestCollection

https://nfdi4energy.github.io/ERSmeta/#ersmeta:TestCollection

A collection of Software Tests

Property name URI Expected value Card. Description
collectionSize schema:collectionSize xsd:integer
0..1
Number of the tests of the software.
url schema:url xsd:string
0..*
Link to one or multiple test case.

Validation

https://nfdi4energy.github.io/ERSmeta/#ersmeta:Validation
Property name URI Expected value Card. Description
additionalType schema:additionalType

Empirical validation, Analytical verification, Inter-model comparison

0..1
Type of the validation.
url schema:url xsd:anyURI
0..1
Link to further information on the validation.
similarityOfResults ersmeta:similarityOfResults xsd:float
0..1
Factor on how close the validation was.