Skip to content

Add .zenodo.json and CITATION.cff to cite core authors #759

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

Merged
merged 3 commits into from
May 23, 2025

Conversation

tomvothecoder
Copy link
Collaborator

@tomvothecoder tomvothecoder commented May 14, 2025

Description

This pull request adds metadata files to enhance citation and attribution for the xCDAT project. The changes include the addition of a .zenodo.json file for Zenodo integration and a CITATION.cff file for standardized citation formatting.

Metadata Additions:

  • .zenodo.json: Added a file specifying project creators, their affiliations, and ORCID identifiers to enable proper attribution when the project is archived on Zenodo.

  • CITATION.cff: Added a file providing citation details, including project title, abstract, DOI, license, repository link, and preferred citation format, to facilitate standardized referencing of the xCDAT project.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

If applicable:

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass with my changes (locally and CI/CD build)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have noted that this is a breaking change for a major release (fix or feature that would cause existing functionality to not work as expected)

Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds a .zenodo.json file that provides citation metadata for core authors.

  • Added a new .zenodo.json file containing creator details such as names, affiliations, and ORCID identifiers.

@tomvothecoder tomvothecoder added the type: docs Updates to documentation label May 14, 2025
Copy link

codecov bot commented May 14, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (14f876b) to head (e960f7f).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #759   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           16        16           
  Lines         1702      1702           
=========================================
  Hits          1702      1702           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@tomvothecoder tomvothecoder changed the title Add .zenodo.json to cite core authors Add .zenodo.json and CITATION.cff to cite core authors May 14, 2025
@tomvothecoder tomvothecoder requested a review from Copilot May 14, 2025 20:24
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds two metadata files to enhance citation and proper attribution for the xCDAT project.

  • Adds CITATION.cff with comprehensive citation details including abstract, DOI, and a preferred citation article.
  • Adds .zenodo.json with creator metadata to support Zenodo integration.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
CITATION.cff Introduces citation metadata with detailed publication info.
.zenodo.json Provides creator metadata, including affiliations and ORCID.

{
"name": "Vo, Tom",
"affiliation": "Lawrence Livermore National Laboratory",
"orcid": "0000-0002-2461-0191"
Copy link
Preview

Copilot AI May 14, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The ORCID values in .zenodo.json are provided as bare numbers, whereas in CITATION.cff they are full URLs. For consistency, consider using full ORCID URLs in .zenodo.json.

Copilot uses AI. Check for mistakes.

@tomvothecoder tomvothecoder merged commit a34ada1 into main May 23, 2025
10 checks passed
@github-project-automation github-project-automation bot moved this from Todo to Done in xCDAT Development May 23, 2025
@tomvothecoder tomvothecoder deleted the doc/758-zenodo-list branch May 23, 2025 19:10
tomvothecoder pushed a commit that referenced this pull request Jun 2, 2025
Adds sparse as a dependency

Fixes formatting

Updates docstrings

[PR]: Enable `skipna` for spatial and temporal mean operations (#655)

Co-authored-by: Tom Vo <[email protected]>

Removes pdb import

Fix incorrect dimension used for temporal weights generation (#749)

Adds mask creation to create_grid and fixes aligning grid dimension for xesmf

Lifting src mask generation

Adds create_nan_mask argument to regrid2

Adds docstring to create_mask

Add weight threshold option for spatial averaging (#672)

- Add parameter `min_weight` to `SpatialAccessor.average()`

Replace support section with endorsements (#757)

 Drop Python 3.9 support and add compatibility for Python 3.13 (#721)

Fixes typings

Fixes spelling error

Fixes black formatting issue

Adds scipy dependency

Add `.zenodo.json` and `CITATION.cff` to cite core authors (#759)

Refactors create_nan_mask

Adds tests and fixes mask dimension ordering

Fixes variable name

Adds create_nan_mask support to xesmf

Chunk weights before broadcasting/masking in _group_average (#767)

Use the median of the delta instead of min for time freq inference  (#768)

Co-authored-by: Tom Vo <[email protected]>

Adds missing test
tomvothecoder pushed a commit that referenced this pull request Jun 2, 2025
Adds sparse as a dependency

Fixes formatting

Updates docstrings

[PR]: Enable `skipna` for spatial and temporal mean operations (#655)

Co-authored-by: Tom Vo <[email protected]>

Removes pdb import

Fix incorrect dimension used for temporal weights generation (#749)

Adds mask creation to create_grid and fixes aligning grid dimension for xesmf

Lifting src mask generation

Adds create_nan_mask argument to regrid2

Adds docstring to create_mask

Add weight threshold option for spatial averaging (#672)

- Add parameter `min_weight` to `SpatialAccessor.average()`

Replace support section with endorsements (#757)

 Drop Python 3.9 support and add compatibility for Python 3.13 (#721)

Fixes typings

Fixes spelling error

Fixes black formatting issue

Adds scipy dependency

Add `.zenodo.json` and `CITATION.cff` to cite core authors (#759)

Refactors create_nan_mask

Adds tests and fixes mask dimension ordering

Fixes variable name

Adds create_nan_mask support to xesmf

Chunk weights before broadcasting/masking in _group_average (#767)

Use the median of the delta instead of min for time freq inference  (#768)

Co-authored-by: Tom Vo <[email protected]>

Adds missing test
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Updates to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

1 participant