Add a citation

[doulikecookiedough]

Create a datacite.xml doc and include a citation in README.md like what was done for Metacat. More info here

[doulikecookiedough]

WIP datacite.xml Document. Details to be confirmed in back-end meeting.

Updated 2024-10-01

DataCite XML for HashStore 1.1.0 (datacite.xml)

<?xml version="1.0"?>
<resource xmlns="http://datacite.org/schema/kernel-4" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://datacite.org/schema/kernel-4 http://schema.datacite.org/meta/kernel-4/metadata.xsd">
  <identifier identifierType="DOI">MISSING_TOFILL_GET_FROM_EZID_WHEN_READY</identifier>
  <creators>
    <creator>
      <creatorName>Dou Mok</creatorName>
      <givenName>DouMing</givenName>
      <familyName>Mok</familyName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0002-6076-8092</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
    <creator>
      <creatorName>Matthew Brooke</creatorName>
      <givenName>Matthew</givenName>
      <familyName>Brooke</familyName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0002-1472-913X</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
    <creator>
      <creatorName>Jing Tao</creatorName>
      <givenName>Jing</givenName>
      <familyName>Tao</familyName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0002-1209-5268</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
    <creator>
      <creatorName>Jeanette Clark</creatorName>
      <givenName>Jeanette</givenName>
      <familyName>Clark</familyName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0003-4703-1974</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
    <creator>
      <creatorName>Matthew B. Jones</creatorName>
      <givenName>Matthew B.</givenName>
      <familyName>Jones</familyName>
      <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0003-0077-4738</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
    <creator>
      <creatorName>Ian M. Nesbitt</creatorName>
      <givenName>Ian</givenName>
      <familyName>Nesbitt</familyName>
     <nameIdentifier nameIdentifierScheme="ORCID" schemeURI="https://orcid.org/">0000-0001-5828-6070</nameIdentifier>
      <affiliation affiliationIdentifier="https://ror.org/055hrh286" affiliationIdentifierScheme="ROR" schemeURI="https://ror.org/">Arctic Data Center</affiliation>
    </creator>
  </creators>
  <titles>
    <title>HashStore (python) - Object Storage System</title>
  </titles>
  <publisher>Arctic Data Center</publisher>
  <publicationYear>2024</publicationYear>
  <resourceType resourceTypeGeneral="Software">Software</resourceType>
  <dates>
    <date dateType="Created">2024-10-01</date>
  </dates>
  <version>1.1.0</version>
  <rightsList>
    <rights rightsURI="https://spdx.org/licenses/Apache-2.0.html">Apache-2.0</rights>
  </rightsList>
  <fundingReferences>
    <fundingReference>
      <funderName>National Science Foundation</funderName>
      <funderIdentifier funderIdentifierType="Crossref Funder ID">https://doi.org/10.13039/100000001</funderIdentifier>
      <awardNumber awardURI="https://www.nsf.gov/awardsearch/showAward?AWD_ID=2042102">2042102</awardNumber>
      <awardTitle>Advancing Arctic research and education through data preservation and reuse at the Arctic Data Center</awardTitle>
    </fundingReference>
    <fundingReference>
      <funderName>U.S. Department of Energy</funderName>
      <funderIdentifier funderIdentifierType="Crossref Funder ID">https://doi.org/10.13039/100000015</funderIdentifier>
      <awardTitle>The Environmental System Science Data Infrastructure for a Virtual Ecosystem (ESS-DIVE 2020)</awardTitle>
    </fundingReference>
  </fundingReferences>
</resource>

[doulikecookiedough]

Citation has been updated based on team discussion.

TO DO:

• Request ADC DOI from @taojing2002
• Update __init__.py for accuracy
• Update README.md
  • Author section is missing Jeanette & Ian
  • Update getting a HashStore example, uses sha256 which should be SHA-256
    • Also update HashStoreFactory for same incorrect values
• Add human-ness to CONTRIBUTING.md (see metacatui for example)

[doulikecookiedough]

Completed via Feature-118: Citation Package Part 1

• Update README.md
• Update HashStoreFactory inaccurate values
• Add human-ness to CONTRIBUTING.md

To Do Remaining:

• Request ADC DOI from Jing
• Finalize citation.xml content (date, DOI)

[doulikecookiedough]

This has been completed via Feature-108: Citation Update Part 2