Skip to content
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

STY: Completed funding institution list #1168

Merged
merged 18 commits into from
Feb 6, 2024
Merged

Conversation

rstoneback
Copy link
Collaborator

@rstoneback rstoneback commented Jan 11, 2024

Addresses #1168

Description

Completes the list of funding institutions from most awesome down to NASA

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

Visual inspection of the RTD generated docs

Checklist:

  • Make sure you are merging into the develop (not main) branch
  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules
  • Add a note to CHANGELOG.md, summarizing the changes

If this is a release PR, replace the first item of the above checklist with the release
checklist on the wiki: https://github.com/pysat/pysat/wiki/Checklist-for-Release

@rstoneback rstoneback changed the title STY: Completed funding institution list from most awesome all the way… STY: Completed funding institution list Jan 11, 2024
@rstoneback rstoneback mentioned this pull request Jan 16, 2024
25 tasks
@jklenzing
Copy link
Member

TODO: update with single acknowledgments file and point to this from the individual files

@jklenzing jklenzing marked this pull request as draft January 17, 2024 20:34
@jklenzing jklenzing added this to the 3.2.0 Release milestone Jan 17, 2024
@rstoneback
Copy link
Collaborator Author

rstoneback commented Jan 19, 2024

I added the acknowledgements and added a test sentence for pointing to acknowledgements.txt

 # This work was supported by the institutions, missions, and programs listed in
 # acknowledgements.txt.

acknowledgements.txt Outdated Show resolved Hide resolved
@rstoneback
Copy link
Collaborator Author

Apologies for stringing out the pushes. I am out of practice :)

@rstoneback rstoneback marked this pull request as ready for review January 22, 2024 17:26
Copy link
Member

@aburrell aburrell left a comment

Choose a reason for hiding this comment

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

We could consider finding a way to pipe the acknowledgements.txt lines into zenodo using the "notes" section.

docs/index.rst Outdated Show resolved Hide resolved
pysat/utils/_core.py Outdated Show resolved Hide resolved
acknowledgements.txt Outdated Show resolved Hide resolved
Co-authored-by: Jeff Klenzing <19592220+jklenzing@users.noreply.github.com>
acknowledgements.txt Outdated Show resolved Hide resolved
acknowledgements.txt Outdated Show resolved Hide resolved
acknowledgements.txt Outdated Show resolved Hide resolved
acknowledgements.txt Outdated Show resolved Hide resolved
Copy link
Member

@aburrell aburrell left a comment

Choose a reason for hiding this comment

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

I would recommend moving 'acknowledgements.txt' to 'ACKNOWLEDGEMENTS.md', to be consistent with the naming conventions of the rest of the informative files in this directory.

@rstoneback
Copy link
Collaborator Author

We could consider finding a way to pipe the acknowledgements.txt lines into zenodo using the "notes" section.

I've found the notes section of the .zenodo.json but .json itself doesn't have functionality to load a file. Zenodo, according to its docs, interprets the notes portion of the .json as a string (html supported). Within html we'd need something like javascript to actually load the file, presuming Zenodo would allow that code to access files.... In other words, I currently don't see how to connect the acknowledgments into zenodo unless we manually copy with each release.

@rstoneback rstoneback merged commit 05ef92f into rc_3_2_0 Feb 6, 2024
26 checks passed
@rstoneback rstoneback deleted the funding_institutions branch February 6, 2024 20:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants