From 8697124376f6010820ec80cac489f58bcb2bde5f Mon Sep 17 00:00:00 2001 From: Jacob Cain <115182890+jrcain-usgs@users.noreply.github.com> Date: Wed, 15 May 2024 10:10:14 -0700 Subject: [PATCH] New Instructions for Citing ISIS (#5453) * Initial changes to readme for new DOI listing location * initial readme for new DOIs * Citing ISIS - update readme for 8.0.3 * remove astrodiscuss, move small sections to top so not buried * rearrange TOC --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index d0c762ac38..3f00f6f6e1 100644 --- a/README.md +++ b/README.md @@ -4,19 +4,17 @@ # ISIS -[](https://gitter.im/USGS-Astrogeology/isis3_cmake?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) -[](https://astrodiscuss.usgs.gov/) [](https://anaconda.org/usgs-astrogeology/isis3) [](https://anaconda.org/usgs-astrogeology/isis) -[](https://doi.org/10.5281/zenodo.2563341) +[](https://doi.org/10.5066/P13YBMZA) ## Table of Contents * [Requests for Comment](README.md#Requests-for-Comment) * [FAQ](README.md#FAQ) -* [Installation](README.md#Installation) * [ISIS Tutorials](README.md#ISIS-Tutorials) * [Citing ISIS](README.md#Citing-ISIS) +* [Installation](README.md#Installation) * [Start Contributing](https://github.com/USGS-Astrogeology/ISIS3/wiki/How-to-Start-Contributing) * [ISIS Data Area](README.md#The-ISIS-Data-Area) * [ISIS Test Data](README.md#ISIS-Test-Data) @@ -25,16 +23,25 @@ ## Requests for Comment -The ISIS project uses a Request for Comment (RFC) model whereby major potential changes to the code base, data area, or binary delivery process are proposed, iterated on by any interested parties, and potentially adopted. Right now, RFCs are being housed in this repository's [wiki](https://github.com/USGS-Astrogeology/ISIS3/wiki) with associated discussions occurring on [astrodiscuss](https://astrodiscuss.usgs.gov). +The ISIS project uses a Request for Comment (RFC) model where major changes to the code base, data area, or binary delivery process are proposed, iterated on, and potentially adopted. Right now, RFCs are being housed in this repository's [wiki](https://github.com/USGS-Astrogeology/ISIS3/wiki). Current open RFCs: * No Requests for Comment are currently open - We encourage all contributors and users to review open RFCs and comment as these proposed changes will impact use of the software. + We encourage all contributors and users to review open RFCs and comment, as these proposed changes will impact use of the software. ## FAQ We maintain a list of frequently encountered questions and issues. Before opening a new issue, please take a look at the [FAQ](https://github.com/USGS-Astrogeology/ISIS3/wiki/FAQ). +## ISIS Tutorials +Please refer to the GitHub wiki page [ISIS Online Workshops](https://github.com/USGS-Astrogeology/ISIS3/wiki/ISIS_Online_Workshops) for current ISIS tutorials. + +## Citing ISIS + +The badge at the top of this README lists the DOI of the most recent ISIS version. As of 05/09/2024, the latest release of ISIS is version 8.0.3, and its DOI is [`10.5066/P13YBMZA`](https://doi.org/10.5066/P13YBMZA). + +The [Releases Page on GitHub](https://github.com/DOI-USGS/ISIS3/releases) lists the DOI for each version of ISIS. Older versions may be listed on [Zenodo](https://doi.org/10.5281/zenodo.2563341). It is good practice to cite the version of the software being used by the citing work, so others can reproduce your exact results. + ## Installation This installation guide is for ISIS users interested in installing ISIS (3.6.0)+ through conda. @@ -385,12 +392,6 @@ To build and compile ISIS requires following the instructions listed below, whic - [Building ISIS documentation](https://github.com/USGS-Astrogeology/ISIS3/wiki/Developing-ISIS3-with-cmake#building-isis3-documentation) - [What to do if you encounter any problems](https://github.com/USGS-Astrogeology/ISIS3/wiki/Developing-ISIS3-with-cmake#problems) -## ISIS Tutorials -Please refer to the GitHub wiki page [ISIS Online Workshops](https://github.com/USGS-Astrogeology/ISIS3/wiki/ISIS_Online_Workshops) for current ISIS tutorials. - -## Citing ISIS -This project uses a [Zenodo](https://zenodo.org) generated DOI. The badge at the top of this README links to the DOI for the [latest release](https://doi.org/10.5281/zenodo.2563341). It is [good practice](https://help.zenodo.org) (See 'Which DOI Should I Use in Citations?') to cite the version of the software being used by the citing work. To obtain this DOI, one can follow the [link to the latest version](https://doi.org/10.5281/zenodo.2563341) and then check the right sidebar area titled **Versions** for a listing of all ISIS versions that currently have a Zenodo DOI. - ## The ISIS Data Area ### Ancillary Data -- GitLab