EnergyResearchSoftware |
| Prefix | Namespace |
|---|---|
| codemeta | https://codemeta.github.io/terms/ |
| ersmeta | https://nfdi4energy.github.io/ERSmeta/#ersmeta: |
| m4i | http://w3id.org/nfdi4ing/metadata4ing# |
| oeo | http://openenergy-platform.org/ontology/oeo/ |
| okn | https://w3id.org/okn/o/sd# |
| ontosoft | http://ontosoft.org/software# |
| prov | http://www.w3.org/ns/prov# |
| schema | http://schema.org/ |
| xsd | http://www.w3.org/2001/XMLSchema# |
This metadata schema includes general metadata elements for research software in the energy domain.
https://nfdi4energy.github.io/ERSmeta/#ersmeta:EnergyResearchSoftwareThis is the main element to describe energy research software.
| 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 (URL) 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/entity/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..*
|
Link (URL) to a graphical overview on the functionality of the software. |
| domain | schema:applicationCategory |
xsd:stringChemistry, Computer Science, Construction Engineering and Architecture, Economics, Electrical Engineering and Information Technology, Fluid Mechanics, Technical Thermodynamics and Thermal Energy Engineering, Geosciences, Jurisprudence, Materials Engineering, Materials Science, Mathematics, Mechanics and Constructive Mechanical Engineering, Physics, Process Engineering, Technical Chemistry, Production Technology, Social Science, Systems Engineering |
0..*
|
Research domain for which the software was written. |
| category | schema:applicationSubCategory |
xsd:stringControl strategies for energy systems, Energy markets, Grid planning, Other, Research on components, Transition of the energy system |
0..*
|
Research category for which the software was written. |
| softwareType | ersmeta:softwareType |
xsd:stringCommand-line tool, Database portal, Desktop application, GUI-framework, Library, Plug-in, Script, Web API, Web application, Web service, Workbench, Workflow |
1..*
|
Type of software application, e.g. 'script'. |
| roleInResearch | prov:hadRole |
xsd:stringAgent-based Modeling, Collaboration Software, Control and Monitoring Software (Embedded, Web-based, Native), Data Analytics, Data Assimilation, Data Collection, Data Management, Decision Analysis, Integrative Analysis, Laboratory Notebooks, Libraries, Machine Learning, Modeling and Simulation, Numerical Modeling, Observation Data Analytics, Pipelines/Workflows, Proof-of-Concept Software, Research Infrastructure Software, Scientific Visualization, Simulation Data Analytics, Software Management, Statistical Analysis |
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 |
xsd:stringAbandoned, Active, Concept, Inactive, Moved, Suspended, Unsupported, WIP |
1..*
|
Description of development status, e.g. Active, inactive, suspended. See repostatus.org |
| developerStructure | ersmeta:developerStructure |
xsd:stringCommunity (Closed Source Research Software), Community (Open Source Research Software), Community (Research Software as a Service), Contractor (Closed Source Research Software), Contractor (Open Source Resarch Software), Contractor (Research Software as a Service), Individual Researcher, Local Research Group, Project Group |
0..*
|
Structure of the development team. |
| cycleOfUpdates | ersmeta:cycleOfUpdates |
xsd:stringWeekly, Monthly, Quarterly, Irregularly |
0..*
|
How often is the software updated? |
| issueTracker | codemeta:issueTracker |
xsd:anyURI |
0..*
|
Link (URL) 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. A contributor refers to anyone who aids in software development in any capacity, from coding to testing, highlighting the collaborative nature of software projects. |
| author | schema:author |
Person |
0..*
|
A person who has authored the software. An author in software authorship is someone who significantly contributes to the creation and development of software, including roles like coding, project management, and documentation. |
| maintainer | schema:maintainer |
Person |
0..*
|
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:anyURI |
0..*
|
Link (URL) 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 (URL) to the documentation describing the code and is useful for developers. |
| readme | codemeta:readme |
xsd:anyURI |
0..1
|
Link (URL) to the documentation describing the code and is useful for developers. |
| buildInstruction | codemeta:buildInstruction |
xsd:anyURI |
0..1
|
Link (URL) 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 |
xsd:stringannual, daily, hourly, minutely, monthly, none, other, quarter-hourly, secondly, unlimited, weekly |
0..*
|
Supported temporal resolution of the software. Temporal resolution is the resolution that indicates time-dependent the level of detail. |
| temporalCoverage | schema:temporalCoverage |
xsd:stringShort 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 |
xsd:stringStationary, 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 |
xsd:string1D, 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 |
xsd:stringHigh Voltage, Low Voltage, Medium Voltage, None |
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 |
xsd:stringLaptop, Desktop Computer/Work station, HPC |
0..*
|
Typical minimal hardware which is required to run the software. |
| typicalExecutionTime | schema:timeRequired |
xsd:float |
0..*
|
Typical execution time of the software in seconds. |
| 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 |
xsd:stringHard, 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/entity/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 this metadata. |
https://nfdi4energy.github.io/ERSmeta/#ersmeta:CommunityInteractionInteraction with the community of the research software.
| Property name | URI | Expected value | Card. | Description |
|---|---|---|---|---|
| additionalType | schema:additionalType |
xsd:stringMailinglist, Issues, In-person meet-ups, Forum, Online meetings, Github discussions |
0..1
|
Type of the interaction. |
| url | schema:url |
xsd:anyURI |
0..1
|
Link (URL) to further information on the community interaction. |
http://schema.org/SoftwareApplicationA 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. |
http://schema.org/CreativeWorkThe most generic kind of creative work, including books, movies, photographs, software programs, etc.
| Property name | URI | Expected value | Card. | Description |
|---|---|---|---|---|
| identifier | schema:identifier |
IRIOrLiteral |
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. |
http://schema.org/DataSetA 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 |
xsd:stringbinary, csv, DataFrame/Serie, db, JSON, mat, mdf5, other, Pandas, txt, xml, xlsx, YAML |
0..*
|
Format of the dataset. |
| url | schema:url |
xsd:string |
0..*
|
Link (URL) to the dataset. |
https://nfdi4energy.github.io/ERSmeta/#ersmeta:EnergyComponentAn energy component modelled within a simulation software
| 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 |
xsd:stringlow (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. |
https://nfdi4energy.github.io/ERSmeta/#ersmeta:ExampleExample for a software usage
| Property name | URI | Expected value | Card. | Description |
|---|---|---|---|---|
| additionalType | schema:additionalType |
xsd:stringMinimal, 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 (URL) to the example. |
http://schema.org/GrantA 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. |
https://nfdi4energy.github.io/ERSmeta/#ersmeta:InterfaceAn 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 |
xsd:stringcsv, 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. |
http://schema.org/MonetaryAmountA 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. |
https://nfdi4energy.github.io/ERSmeta/#ersmeta:OptimizationToolA 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. |
http://schema.org/OrganizationAn 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. |
http://schema.org/PersonA 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. |
schema:email |
xsd:string |
0..*
|
Email address. | |
| roleName | schema:roleName |
xsd:stringArchitecture, Coding, Debugging, Design, Documentation, Maintenance, Management, Support, Testing |
0..*
|
Detailed role of a person. |
http://schema.org/ReviewA 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. |
http://schema.org/ScholarlyArticleA scholarly article.
| Property name | URI | Expected value | Card. | Description |
|---|---|---|---|---|
| identifier | schema:identifier |
xsd:anyURI |
0..1
|
URL identifier, ideally a DOI for a publication. |
https://nfdi4energy.github.io/ERSmeta/#ersmeta:TestCollectionA 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:anyURI |
0..*
|
Link (URL) to one or multiple test case. |
https://nfdi4energy.github.io/ERSmeta/#ersmeta:Validation| Property name | URI | Expected value | Card. | Description |
|---|---|---|---|---|
| additionalType | schema:additionalType |
xsd:stringEmpirical validation, Analytical verification, Inter-model comparison |
0..1
|
Type of the validation. |
| url | schema:url |
xsd:anyURI |
0..1
|
Link (URL) to further information on the validation. |
| similarityOfResults | ersmeta:similarityOfResults |
xsd:float |
0..1
|
Factor on how close the validation was. |