SciTools / iris

A powerful, format-agnostic, and community-driven Python package for analysing and visualising Earth science data
https://scitools-iris.readthedocs.io/en/stable/
BSD 3-Clause "New" or "Revised" License
635 stars 283 forks source link

Make it clearer / easier to find how to cite Iris #4679

Open wjbenfold opened 2 years ago

wjbenfold commented 2 years ago

📚 Documentation

It's currently pretty hard to work out how to cite Iris (and not in the docs). I think the only indication is that we have a Zenodo tag on our GitHub README. I'd suggest improving this.

Examples from elsewhere (both what they use and how you find out about it):

tkknight commented 2 years ago

We have a docs page for this but I expect it could do with an overhaul.

https://scitools-iris.readthedocs.io/en/latest/userguide/citation.html#citing-iris

wjbenfold commented 2 years ago

Odd - when I search the docs for the word "cite" I don't get that page, only a very old what's new entry (which does link to that page). Maybe it's just a matter of cross-linking a bit better and updating that page

github-actions[bot] commented 1 year ago

In order to maintain a backlog of relevant issues, we automatically label them as stale after 500 days of inactivity.

If this issue is still important to you, then please comment on this issue and the stale label will be removed.

Otherwise this issue will be automatically closed in 28 days time.

trexfeathers commented 1 year ago

@HGWright any thoughts on the status of this? I've lost track if we've already done the "make it clearer / easier" step

HGWright commented 1 year ago

@trexfeathers Thanks for the reminder I had forgoten about this. It still needs work to finish #5161.