PrincetonUniversity / SPEC

The Stepped-Pressure Equilibrium Code, an advanced MRxMHD equilibrium solver.
https://princetonuniversity.github.io/SPEC/
GNU General Public License v3.0
25 stars 5 forks source link

404 URLs in README #205

Open missing-user opened 1 day ago

missing-user commented 1 day ago

Sometime over the last few months the links referenced in the README have gone stale, specifically the ones under the user directory of https://w3.pppl.gov/~shudson

Since these URLs are also being referenced by other documentations (e.g. simsopt) it might be good to setup redirects @SRHudson

Impacted URLs:

jonathanschilling commented 17 hours ago

Maybe we should just remove those links in the doxygen parts of the codebase and replace them with info that is put in their place directly in doxygen?

missing-user commented 14 hours ago

Sure, I was able to recover these files from the InternetArchive, and would just put them directly in the repo for now. SpecFlowchart.pdf SpecPreset.pdf

https://w3.pppl.gov/~shudson/Spec/spec.html used to host a list of SPEC related publications, not sure how we can replace that...

jloizu commented 2 hours ago

Hello, nice to see so much activity on SPEC development! :)

About the publications, it would be good if we simply add a list on the SPEC github repo with all SPEC-related publications (we can put the main ones, and then people can add any additional paper they did using SPEC?)

jons-pf commented 2 hours ago

@jloizu Regarding publications, we have this page which could be extended: https://princetonuniversity.github.io/SPEC/citelist.html and also a ready-to-use BibTex file: https://github.com/PrincetonUniversity/SPEC/blob/master/spec_refs.bib Both are absolutely not up-to-date.

We might also want to consider a CITATION.cff file for SPEC: https://citation-file-format.github.io/

missing-user commented 1 hour ago

@jloizu Regarding publications, we have this page which could be extended: https://princetonuniversity.github.io/SPEC/citelist.html and also a ready-to-use BibTex file: https://github.com/PrincetonUniversity/SPEC/blob/master/spec_refs.bib Both are absolutely not up-to-date.

We might also want to consider a CITATION.cff file for SPEC: https://citation-file-format.github.io/

I'll prepare a draft for citations.cff that we can iterate on.