DOI
Digital Object Identifiers (DOI)
Scope
- This wiki page summarises relevant facts about DOI and related persistent Identifiers (PID) for the OSGeo communities.
- A DOI is a persistent identifier (PID).
- More infomation about PID for OSGeo is available here in the wiki
Useful background information
- Introduction to DOI (NASA)
- DOI registration 101 @ UC Berkeley (wayback machine memento)
- Introduction to the Zenodo open access repository
- Zenodo FAQ
HowTo information about ORCID (Open Researcher and Contributor ID -> a PID for people)
- ORCID FAQ
- ORDID introduction video
- HOWTO: Register an ORCID (Video tutorial)
- How to set up an ORCID account for credit propagation (e.g. Version-DOI of OSGeo project software releases will automagically appear in the "works" section of the associated ORCID accounts)
Howto information for GitHub Repo maintainers (source Zenodo FAQ)
My organizational repository does not show up on the GitHub list
"In order to see and archive your organizational repositories on Zenodo you will need to have "Admin" permissions on said repository, either as an Admin of the organization or an Admin of one of your organization's repositories. Additionally, please make sure that the OAuth application on GitHub is granting permissions not only to your personal repositories but also to your organizational ones - to verify that go to your GitHub OAuth settings in your profile, and click on the Zenodo application to see more details. Make sure that Zenodo is given access (green tick) to your organization under "Organization access".
After that, navigate to your Zenodo GitHub settings page and click the "Sync now" button at the top."
I made a GitHub release, but it does not show up on Zenodo.
"Make sure the repository was enabled before the release was made, otherwise feel free to contact ZENODO."
Is it possible to archive a GitHub repository, before it was enabled on Zenodo?
"Only the repositories which were enabled before a release was made will be archived automatically. If you want to archive some of your old releases, you can always download a release ZIP from GitHub and upload it to Zenodo using our web interface as a regular upload."
How to change the default metadata for my GitHub releases?
"You can include metadata in a .zenodo.json file at the root of your GitHub repository. This file's contents should be in line with the Zenodo deposit metadata schema and will be used to update the metadata from future GitHub releases. For more information on how to create a .zenodo.json file, you can have a look at our GitHub integration documenation."
Do you support other software metadata files, like CITATION.cff or codemeta.json?
"Part of our plans and ongoing work is to take into account or improve our integration of other software metadata schemas such as the Citation File Format (CFF) and CodeMeta. We are working closely with our users and scholarly software and citation communities to figure out exactly when, in what form, and how all these different metadata schemas and their files will be integrated into Zenodo."
How does a CITATION.cff file affect the metadata of my GitHub release?
"When we find a CITATION.cff file in your GitHub repository's root folder, we make a best-effort attempt at parsing Zenodo-compatible metadata from it. For backwards-compatibility, if you have a .zenodo.json file in the repository, only the .zenodo.json's metadata will be taken into account. Of course, any existing valid CITATION.cff file will still be used to display the citation box on the GitHub repository page, but will not affect in any way the metadata we extract for your published release Zenodo record."
Do you support versioning for already existing records?
"Yes. However, for uploads published before the 30th of May 2017, you have to first upgrade your record to support versioning. This is done by clicking the “Upgrade to versioned record” button on the record page.
IMPORTANT If you have previously uploaded multiple versions of an upload as individual records on Zenodo, then DO NOT click the button to upgrade your record with versioning support. Please contact us so we can link the records under one versioning scheme.
Clicking the “Upgrade to versioned record” button on any of the records you would like to link, will irreversibly register them as individually-versioned records.
If you used the GitHub integration to archive your software on Zenodo, then we have already migrated and linked your records to support versioning."
Usage examples for people writing articles
DOI
How to include a DOI-based reference to a LaTEX/Overleaf document.
BEWARE: As of now (20230327) it remains to be confirmed that DOI-tags in citations work without the https://doi.org-header. This might (just) reuslt in human readable information, but not machine-readable.
Publication DOI
@article{Chen_2003_Giants, title={On the Shoulders of Giants}, url={\url{https://doi.org/10.1007/978-1-4471-0051-5_5}}, DOI={10.1007/978-1-4471-0051-5_5}, journal={Mapping Scientific Frontiers: The Quest for Knowledge Visualization}, publisher={Springer London}, author={Chen, Chaomei}, year={2003}, pages={135–166} }
Video DOI
@article{Inman_1987, title={GRASS}, url={https://av.tib.eu/media/12963}, DOI={10.5446/12963}, abstractNote={Video presentation explaining the features and capabilities of this computer-based mapping system.}, publisher={Moving Pictures, US Army Construction Engineering Research Laboratory}, author={Inman, Roger J.}, year={1987}, language={en} }
Software Concept DOI (a reference to a software project as a whole)
@article{GRASS_CONCEPT_DOI, title={OSGeo/grass: GRASS GIS 8.2.0}, url={https://zenodo.org/record/5176030}, DOI={10.5281/ZENODO.5176030}, abstractNote={ .. CONTENT OMMITTED FOR BREVITY ..}, year={2022}, month={Jun} }
Software Version DOI (a reference to a particular software release)
@article{QGIS_Contributors_2022, title={QGIS}, url={https://doi.org/10.5281/zenodo.5869837}, DOI={10.5281/ZENODO.5869837}, publisher={Zenodo}, author={QGIS Contributors}, year={2022}, month={Jan} }
ORCID
How to include ORCIDs to a LaTEX/Overleaf document: Include these packages: \usepackage{orcidlink} \usepackage[hidelinks]{hyperref}
\author{ Peter Löwe\,\orcidlink{0000-0003-2257-0517}~\textsuperscript{1}\thanks{Corresponding author}, Markus Neteler\,\orcidlink{0000-0003-1916-1966}~\textsuperscript{2} } (Source: OSGEO, PERSISTENT IDENTIFIERS AND THE SHAPE OF THINGS TO COME)
ROR
TBD: How to include a PID for an institution (like OSGeo) from the Research Organisation Registry (ROR) ?
Added-value services based on DOI
DOI available for OSGeo Projects
<Add your project DOI here, while maintaining alphabetical order>
Projects considering a DOI
- degree
- (NASA World Wind)
<Add your project here>
This is an incomplete overview over geospatial data sources which can be referenced by DOI. Many more datasets are available in Open Access repositories such as Zenodo
GRASS GIS
- New Orleans Dataset for GRASS GIS https://doi.org/10.5281/zenodo.3359642
- Hilltop Arboretum Landform Dataset for GRASS GIS https://doi.org/10.5281/zenodo.3749397
- Sichuan Dataset for GRASS GIS https://doi.org/10.5281/zenodo.3359645
- The Hills of Governor's Island Dataset for GRASS GIS https://doi.org/10.5281/zenodo.5248688
- Louisiana Dataset for GRASS GIS https://doi.org/10.5281/zenodo.3359620
- Natural Earth Dataset for GRASS GIS https://doi.org/10.5281/zenodo.3968936
- Global Dataset for GRASS GIS https://doi.org/10.5281/zenodo.3359632
- Governor's Island Dataset for GRASS GIS https://doi.org/10.5281/zenodo.5248419
(add datasets here)
QGIS
- Governor's Island Dataset for QGIS https://doi.org/10.5281/zenodo.5701115
- Louisiana Dataset for GRASS GIS https://doi.org/10.5281/zenodo.3359620
(add datasets here)
DOI for OSGeo Video Recordings
- Wiki-page: FOSS4G Video Recordings
- Presentation about OSGeo videos with DOI (2016, german)
- Presentation about OSGeo videos with DOI (2017, german)
- Wiki-page: DOI-based Video Quotes
add your DOI badge to your project pages
- please add your DOI badge to your project
See Example Mapbender
- OSGeo project page for Mapbender https://www.osgeo.org/projects/mapbender/
- Mapbender website https://mapbender.org
- Mapbender Repository README https://github.com/mapbender/mapbender-workshop
You badge looks like this (replace your DOI in the Link and svg name)
<a href="https://doi.org/10.5281/zenodo.5887014"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.5887014.svg" alt="DOI"></a>
