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

Generate list of papers that cite sunpy #7094

Closed
wants to merge 1 commit into from

Conversation

wtbarnes
Copy link
Member

@wtbarnes wtbarnes commented Jul 9, 2023

Fixes sunpy/sunpy.org#339

I solved this issue in this repo instead of the webpage because this concerns citations of the core package, not the project more broadly.

This uses the ads package to automatically generate a list of every paper that has cited the SunPy. Here, I'm defining "cited SunPy" to mean either the 2020 v1.0 paper, the 2015 paper, or the JOSS paper. This is easily extended to others e.g. the Zenodo entries.

I'm then using sphinxcontrib-bibtex to generate the bibliography. Right now the formatting is a mess. The default BibTeX style does not look nice in our docs. There are ways to define custom styles with this extension (https://sphinxcontrib-bibtex.readthedocs.io/en/latest/usage.html#custom-formatting-sorting-and-labelling) so we could try that. The other option is to do away with bibtex all together and just format the list by hand using the info from the ADS search. However, if we're going to start using this extension anyway (see #7078), then it would be silly to not use it everywhere.

This is what things currently look like:

image

Some remaining todos:

  • Add ADS token as a secret (currently, this PR will fail because there is no token)
  • Fix formatting
  • Sort citations by year instead of author name
  • Add some sort of check that caches this result so we aren't making this query every time we build the docs

Copy link
Contributor

Hello 👋, Thanks for your contribution to sunpy!
I have marked this pull request as stale because there hasn't had any activity in five months. If you are still working on this, or if it's waiting on a maintainer to look at it then please let us know and we will keep it open. Please add a comment with: @sunpy/sunpy-developers to get someone's attention.
If nobody comments on this pull request for another month, it will be closed.

@github-actions github-actions bot added the Stale label Mar 12, 2024
@wtbarnes wtbarnes closed this Mar 14, 2024
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.

Provide a list of papers that make use of sunpy
1 participant