-
Notifications
You must be signed in to change notification settings - Fork 485
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
7844 codemeta schema #7877
Merged
Merged
7844 codemeta schema #7877
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
98f21ea
feat(metadata): add metadata block for CodeMeta #7844
poikilotherm f9f9cbd
docs(metadata): add CodeMeta reference to user guide
poikilotherm ed485df
feat(metadata): load CodeMeta by default in new installations.
poikilotherm 3c497a1
fix(metadata): fix wrong tab in CodeMeta and rephrase softwareVersion…
poikilotherm 492491e
fix(metadata): add standard name to Codemeta MDB displayName. #7844
poikilotherm 382c1e4
fix(metadata): make CodeMeta TSV usable #7844
poikilotherm 1e8567d
feat(metadata): add i18n properties for CodeMeta #7844
poikilotherm 1229a06
Merge branch 'develop' into 7844-codemeta-schema
poikilotherm c6c669c
refactor(metadata): move CodeMeta to experimental #7844
poikilotherm 79b3092
Merge branch 'develop' into 7844-codemeta-schema
poikilotherm c4e5028
refactor(metadata): rename CodeMeta softwareVersion to codeVersion #7844
poikilotherm d79b4aa
style(metadata): rephrase CodeMeta storage and memory requirements de…
poikilotherm 8d5edf2
feat(metadata): add CodeMeta fields to Solr schema #7844
poikilotherm 018d9e5
Merge branch 'develop' into 7844-codemeta-schema
poikilotherm 8b9d7f5
doc: add release note for CodeMeta block #7844
poikilotherm 9dcbfa0
revert(metadata): remove CodeMeta fields from Solr schema #7844
poikilotherm 114a25a
Merge branch 'develop' into 7844-codemeta-schema
poikilotherm 182abed
Merge branch 'develop' into 7844-codemeta-schema
poikilotherm f1a84b4
fix(metadata): remove typos from CodeMeta files #7844
poikilotherm File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Experimental CodeMeta Schema Support | ||
|
|
||
| With this release, we are adding "experimental" (see note below) support for research software metadata deposits. | ||
|
|
||
| By adding a metadata block for [CodeMeta](https://codemeta.github.io), we take another step extending the Dataverse | ||
| scope being a research data repository towards first class support of diverse F.A.I.R. objects, currently focusing | ||
| on research software and computational workflows. | ||
|
|
||
| There is more work underway to make Dataverse installations around the world "research software ready". We hope | ||
| for feedback from installations on the new metadata block to optimize and lift it from the experimental stage. | ||
|
|
||
| **Note:** like the metadata block for computational workflows before, this schema is flagged as "experimental". | ||
| "Experimental" means it's brand new, opt-in, and might need future tweaking based on experience of usage in the field. | ||
| These blocks are listed here: https://guides.dataverse.org/en/latest/user/appendix.html#experimental-metadata |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| #metadataBlock name dataverseAlias displayName blockURI | ||
| codeMeta20 Software Metadata (CodeMeta v2.0) https://codemeta.github.io/terms/ | ||
| #datasetField name title description watermark fieldType displayOrder displayFormat advancedSearchField allowControlledVocabulary allowmultiples facetable displayoncreate required parent metadatablock_id termURI | ||
| codeVersion Software Version Version of the software instance, usually following some convention like SemVer etc. e.g. 0.2.1 or 1.3 or 2021.1 etc text 0 #VALUE TRUE FALSE FALSE TRUE TRUE FALSE codeMeta20 https://schema.org/softwareVersion | ||
| developmentStatus Development Status Description of development status, e.g. work in progress (wip), active, etc. See repostatus.org for more information. text 1 <a href='https://www.repostatus.org/##VALUE'><img src='https://www.repostatus.org/badges/latest/#VALUE.svg' alt='#VALUE '/></a> TRUE TRUE FALSE TRUE FALSE FALSE codeMeta20 https://www.repostatus.org | ||
| codeRepository Code Repository Link to the repository where the un-compiled, human-readable code and related code is located (SVN, GitHub, CodePlex, institutional GitLab instance, Gitea, etc.). e.g. https://github.com/user/project url 2 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> TRUE FALSE TRUE FALSE TRUE FALSE codeMeta20 https://schema.org/codeRepository | ||
| applicationCategory Application Category Type of software application, e.g. Simulation, Analysis, Visualisation. text 3 #VALUE TRUE FALSE TRUE TRUE TRUE FALSE codeMeta20 https://schema.org/applicationCategory | ||
| applicationSubCategory Application Subcategory Subcategory of the application, e.g. Arcade Game. text 4 #VALUE TRUE FALSE TRUE TRUE FALSE FALSE codeMeta20 https://schema.org/applicationSubCategory | ||
| programmingLanguage Programming Language The programming language(s) used to implement the software (e.g. Python, C++, Matlab, Fortran, Java, Julia,...) text 5 #VALUE TRUE FALSE TRUE TRUE TRUE FALSE codeMeta20 https://schema.org/programmingLanguage | ||
| runtimePlatform Runtime Platform Runtime platform or script interpreter dependencies (e.g. Java 11, Python 3.10 or .Net Framework 4.8). e.g. Python 3.10 text 6 #VALUE TRUE FALSE TRUE TRUE FALSE FALSE codeMeta20 https://schema.org/runtimePlatform | ||
| operatingSystem Operating Systems Operating systems supported (e.g. Windows 10, OSX 11.3, Android 11). text 7 #VALUE TRUE FALSE TRUE TRUE TRUE FALSE codeMeta20 https://schema.org/operatingSystem | ||
| targetProduct Target Product Target Operating System / Product to which the code applies. If applies to several versions, just the product name can be used. text 8 #VALUE TRUE FALSE TRUE TRUE FALSE FALSE codeMeta20 https://schema.org/targetProduct | ||
| buildInstructions Build Instructions Link to installation instructions/documentation e.g. https://github.com/user/project/blob/main/BUILD.md url 9 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE TRUE FALSE FALSE FALSE codeMeta20 https://codemeta.github.io/terms/buildInstructions | ||
| softwareRequirementsItem Software Requirements Required software dependencies none 10 FALSE FALSE TRUE FALSE TRUE FALSE codeMeta20 | ||
| softwareRequirements Name & Version Name and version of the required software/library dependency e.g. Pandas 1.4.3 text 0 #VALUE TRUE FALSE FALSE FALSE TRUE FALSE softwareRequirementsItem codeMeta20 https://schema.org/softwareRequirements | ||
| softwareRequirementsInfoUrl Info URL Link to required software/library homepage or documentation (ideally also versioned) e.g. https://pandas.pydata.org/pandas-docs/version/1.4.3 url 1 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE FALSE TRUE FALSE softwareRequirementsItem codeMeta20 https://dataverse.org/schema/codeMeta20/softwareRequirementsInfoUrl | ||
| softwareSuggestionsItem Software Suggestions Optional dependencies, e.g. for optional features, code development, etc. none 11 FALSE FALSE TRUE FALSE FALSE FALSE codeMeta20 | ||
| softwareSuggestions Name & Version Name and version of the optional software/library dependency e.g. Sphinx 5.0.2 text 0 #VALUE TRUE FALSE FALSE TRUE FALSE FALSE softwareSuggestionsItem codeMeta20 https://codemeta.github.io/terms/softwareSuggestions | ||
| softwareSuggestionsInfoUrl Info URL Link to optional software/library homepage or documentation (ideally also versioned) e.g. https://www.sphinx-doc.org url 1 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE FALSE FALSE FALSE softwareSuggestionsItem codeMeta20 https://dataverse.org/schema/codeMeta20/softwareSuggestionsInfoUrl | ||
| memoryRequirements Memory Requirements Minimum memory requirements. text 12 #VALUE TRUE FALSE FALSE FALSE FALSE FALSE codeMeta20 https://schema.org/memoryRequirements | ||
| processorRequirements Processor Requirements Processor architecture or other CPU requirements to run the application (e.g. IA64). text 13 #VALUE TRUE FALSE TRUE FALSE FALSE FALSE codeMeta20 https://schema.org/processorRequirements | ||
| storageRequirements Storage Requirements Minimum storage requirements (e.g. free space required). text 14 #VALUE TRUE FALSE FALSE FALSE FALSE FALSE codeMeta20 https://schema.org/storageRequirements | ||
| permissions Permissions Permission(s) required to run the code (for example, a mobile app may require full internet access or may run only on wifi). text 15 #VALUE TRUE FALSE TRUE FALSE FALSE FALSE codeMeta20 https://schema.org/permissions | ||
| softwareHelp Software Help/Documentation Link to help texts or documentation e.g. https://user.github.io/project/docs url 16 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE TRUE FALSE TRUE FALSE codeMeta20 https://schema.org/softwareHelp | ||
| readme Readme Link to the README of the project e.g. https://github.com/user/project/blob/main/README.md url 17 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE FALSE FALSE FALSE codeMeta20 https://codemeta.github.io/terms/readme | ||
| releaseNotes Release Notes Link to release notes e.g. https://github.com/user/project/blob/main/docs/release-0.1.md url 18 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE FALSE FALSE FALSE codeMeta20 https://schema.org/releaseNotes | ||
| contIntegration Continuous Integration Link to continuous integration service e.g. https://github.com/user/project/actions url 19 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE TRUE FALSE FALSE FALSE codeMeta20 https://codemeta.github.io/terms/contIntegration | ||
| issueTracker Issue Tracker Link to software bug reporting or issue tracking system e.g. https://github.com/user/project/issues url 20 <a href="#VALUE" target="_blank" rel="noopener">#VALUE</a> FALSE FALSE FALSE FALSE FALSE FALSE codeMeta20 https://codemeta.github.io/terms/issueTracker | ||
| #controlledVocabulary DatasetField Value identifier displayOrder | ||
| developmentStatus Concept concept 0 | ||
| developmentStatus WIP wip 1 | ||
| developmentStatus Active active 2 | ||
| developmentStatus Inactive inactive 3 | ||
| developmentStatus Unsupported unsupported 4 | ||
| developmentStatus Moved moved 5 | ||
| developmentStatus Suspended suspended 6 | ||
| developmentStatus Abandoned abandoned 7 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,85 @@ | ||
| metadatablock.name=codeMeta20 | ||
| metadatablock.displayName=Software Metadata (CodeMeta 2.0) | ||
| datasetfieldtype.codeVersion.title=Software Version | ||
| datasetfieldtype.codeVersion.description=Version of the software instance, usually following some convention like SemVer etc. | ||
| datasetfieldtype.codeVersion.watermark=e.g. 0.2.1 or 1.3 or 2021.1 etc | ||
| datasetfieldtype.developmentStatus.title=Development Status | ||
| datasetfieldtype.developmentStatus.description=Description of development status, e.g. work in progress (wip), active, etc. See repostatus.org for more information. | ||
| datasetfieldtype.developmentStatus.watermark= Development Status | ||
| datasetfieldtype.codeRepository.title=Code Repository | ||
| datasetfieldtype.codeRepository.description=Link to the repository where the un-compiled, human-readable code and related code is located (SVN, GitHub, CodePlex, institutional GitLab instance, Gitea, etc.). | ||
| datasetfieldtype.codeRepository.watermark=e.g. https://github.com/user/project | ||
| datasetfieldtype.applicationCategory.title=Application Category | ||
| datasetfieldtype.applicationCategory.description=Type of software application, e.g. Simulation, Analysis, Visualisation. | ||
| datasetfieldtype.applicationCategory.watermark= | ||
| datasetfieldtype.applicationSubCategory.title=Application Subcategory | ||
| datasetfieldtype.applicationSubCategory.description=Subcategory of the application, e.g. Arcade Game. | ||
| datasetfieldtype.applicationSubCategory.watermark= | ||
| datasetfieldtype.programmingLanguage.title=Programming Language | ||
| datasetfieldtype.programmingLanguage.description=The programming language(s) used to implement the software (e.g. Python, C++, Matlab, Fortran, Java, Julia,...) | ||
| datasetfieldtype.programmingLanguage.watermark= | ||
| datasetfieldtype.runtimePlatform.title=Runtime Platform | ||
| datasetfieldtype.runtimePlatform.description=Runtime platform or script interpreter dependencies (e.g. Java 11, Python 3.10 or .Net Framework 4.8). | ||
| datasetfieldtype.runtimePlatform.watermark=e.g. Python 3.10 | ||
| datasetfieldtype.operatingSystem.title=Operating Systems | ||
| datasetfieldtype.operatingSystem.description=Operating systems supported (e.g. Windows 10, OSX 11.3, Android 11). | ||
| datasetfieldtype.operatingSystem.watermark= | ||
| datasetfieldtype.targetProduct.title=Target Product | ||
| datasetfieldtype.targetProduct.description=Target Operating System / Product to which the code applies. If applies to several versions, just the product name can be used. | ||
| datasetfieldtype.targetProduct.watermark= | ||
| datasetfieldtype.buildInstructions.title=Build Instructions | ||
| datasetfieldtype.buildInstructions.description=Link to installation instructions/documentation | ||
| datasetfieldtype.buildInstructions.watermark=e.g. https://github.com/user/project/blob/main/BUILD.md | ||
| datasetfieldtype.softwareRequirementsItem.title=Software Requirements | ||
| datasetfieldtype.softwareRequirementsItem.description=Required software dependencies | ||
| datasetfieldtype.softwareRequirementsItem.watermark= | ||
| datasetfieldtype.softwareRequirements.title=Name & Version | ||
| datasetfieldtype.softwareRequirements.description=Name and version of the required software/library dependency | ||
| datasetfieldtype.softwareRequirements.watermark=e.g. Pandas 1.4.3 | ||
| datasetfieldtype.softwareRequirementsInfoUrl.title=Info URL | ||
| datasetfieldtype.softwareRequirementsInfoUrl.description=Link to required software/library homepage or documentation (ideally also versioned) | ||
| datasetfieldtype.softwareRequirementsInfoUrl.watermark=e.g. https://pandas.pydata.org/pandas-docs/version/1.4.3 | ||
| datasetfieldtype.softwareSuggestionsItem.title=Software Suggestions | ||
| datasetfieldtype.softwareSuggestionsItem.description=Optional dependencies, e.g. for optional features, code development, etc. | ||
| datasetfieldtype.softwareSuggestionsItem.watermark= | ||
| datasetfieldtype.softwareSuggestions.title=Name & Version | ||
| datasetfieldtype.softwareSuggestions.description=Name and version of the optional software/library dependency | ||
| datasetfieldtype.softwareSuggestions.watermark=e.g. Sphinx 5.0.2 | ||
| datasetfieldtype.softwareSuggestionsInfoUrl.title=Info URL | ||
| datasetfieldtype.softwareSuggestionsInfoUrl.description=Link to optional software/library homepage or documentation (ideally also versioned) | ||
| datasetfieldtype.softwareSuggestionsInfoUrl.watermark=e.g. https://www.sphinx-doc.org | ||
| datasetfieldtype.memoryRequirements.title=Memory Requirements | ||
| datasetfieldtype.memoryRequirements.description=Minimum memory requirements. | ||
| datasetfieldtype.memoryRequirements.watermark= | ||
| datasetfieldtype.processorRequirements.title=Processor Requirements | ||
| datasetfieldtype.processorRequirements.description=Processor architecture or other CPU requirements to run the application (e.g. IA64). | ||
| datasetfieldtype.processorRequirements.watermark= | ||
| datasetfieldtype.storageRequirements.title=Storage Requirements | ||
| datasetfieldtype.storageRequirements.description=Minimum storage requirements (e.g. free space required). | ||
| datasetfieldtype.storageRequirements.watermark= | ||
| datasetfieldtype.permissions.title=Permissions | ||
| datasetfieldtype.permissions.description=Permission(s) required to run the code (for example, a mobile app may require full internet access or may run only on wifi). | ||
| datasetfieldtype.permissions.watermark= | ||
| datasetfieldtype.softwareHelp.title=Software Help/Documentation | ||
| datasetfieldtype.softwareHelp.description=Link to help texts or documentation | ||
| datasetfieldtype.softwareHelp.watermark=e.g. https://user.github.io/project/docs | ||
| datasetfieldtype.readme.title=Readme | ||
| datasetfieldtype.readme.description=Link to the README of the project | ||
| datasetfieldtype.readme.watermark=e.g. https://github.com/user/project/blob/main/README.md | ||
| datasetfieldtype.releaseNotes.title=Release Notes | ||
| datasetfieldtype.releaseNotes.description=Link to release notes | ||
| datasetfieldtype.releaseNotes.watermark=e.g. https://github.com/user/project/blob/main/docs/release-0.1.md | ||
| datasetfieldtype.contIntegration.title=Continuous Integration | ||
| datasetfieldtype.contIntegration.description=Link to continuous integration service | ||
| datasetfieldtype.contIntegration.watermark=e.g. https://github.com/user/project/actions | ||
| datasetfieldtype.issueTracker.title=Issue Tracker | ||
| datasetfieldtype.issueTracker.description=Link to software bug reporting or issue tracking system | ||
| datasetfieldtype.issueTracker.watermark=e.g. https://github.com/user/project/issues | ||
| controlledvocabulary.developmentStatus.concept=Concept | ||
| controlledvocabulary.developmentStatus.wip=WIP | ||
| controlledvocabulary.developmentStatus.active=Active | ||
| controlledvocabulary.developmentStatus.inactive=Inactive | ||
| controlledvocabulary.developmentStatus.unsupported=Unsupported | ||
| controlledvocabulary.developmentStatus.moved=Moved | ||
| controlledvocabulary.developmentStatus.suspended=Suspended | ||
| controlledvocabulary.developmentStatus.abandoned=Abandoned | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't "README" little more standard? (Instead of "Readme".) If others agree, we should change the tsv as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree the filename should be sth with
README. But do we want an all caps field name in the UI?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, I was trying to suggest all caps README in the UI. That's what you have in the description ("Link to the README of the project") and the watermark ("e.g. https://github.com/user/project/blob/main/README.md"), both of which appear in the UI, so it should probably be consistent, right?
It's weird, Codemeta itself has "link to software Readme file" as a description at https://codemeta.github.io/terms/ but before codemeta/codemeta@0818c31 it was all caps README:
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I haven't committed and pushed this, but here's how more consistent all uppercase README would look (name, description, and watermark):