Skip to content

Commit a142f07

Browse files
authored
Legacy ISIS Versions FAQ Item (#135)
* Updated faqs about isis versions, incl legacy. * Added link to installing ISIS in Intro doc * comments on specifying version and LTS * whitespace to retrigger jobs * grammar
1 parent c06f666 commit a142f07

File tree

2 files changed

+57
-13
lines changed

2 files changed

+57
-13
lines changed

docs/getting-started/using-isis-first-steps/introduction-to-isis.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,10 @@ window):
5959
Soils and Rocks at Gusev Crater from Spirit's Microscopic
6060
Imager](https://www.usgs.gov/media/files/textures-soils-and-rocks-gusev-crater-spirits-mi).
6161

62+
## Installing ISIS
63+
64+
ISIS is distributed via conda and compatible with Mac and Unix, see [Installing ISIS](../../how-to-guides/environment-setup-and-maintenance/installing-isis-via-anaconda.md) when you are ready to get ISIS on your computer.
65+
6266
## User Interface for ISIS
6367

6468
-----

docs/getting-started/using-isis-first-steps/isis-faq.md

Lines changed: 53 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -17,26 +17,42 @@
1717

1818
During the installation process, you can use Anaconda’s syntax for specifying version numbers.
1919

20-
To update your version of ISIS, you simply run `conda update -c usgs-astrogeology isis3=<version number>`.
20+
To update your version of ISIS, you simply run `conda update -c usgs-astrogeology isis=<version number>`.
2121

22-
ISIS release candidates are tagged with “RC”. Installing/updating RC’s would require you to explicitly mention the RC label with `-c usgs-astrogeology/label/RC `.
22+
ISIS release candidates are tagged with “RC”. Installing/updating RC’s would require you to explicitly mention the RC label with `-c usgs-astrogeology/label/RC `. ISIS Long Term Support releases are similarly tagged with "LTS".
2323

24-
Examples:
25-
`conda install -c usgs-astrogeology isis`, install the latest version of ISIS
26-
`conda update -c usgs-astrogeology isis`, update to the latest version of ISIS
27-
`conda update -c usgs-astrogeology isis=3.9.1`, update to ISIS version 3.9.1
28-
`conda install -c usgs-astrogeology isis=3.9.1`, install ISIS version 3.9.1
29-
`conda install -c usgs-astrogeology/label/RC isis=3.9.1`, install release candidate for ISIS version 3.9.1
24+
Examples:
25+
`conda install -c usgs-astrogeology isis`, install the latest version of ISIS
26+
`conda update -c usgs-astrogeology isis`, update to the latest version of ISIS
27+
`conda update -c usgs-astrogeology isis=7.2.0`, update to ISIS version 7.2.0
28+
`conda install -c usgs-astrogeology isis=7.2.0`, install ISIS version 7.2.0
29+
`conda install -c usgs-astrogeology/label/RC isis=7.2.0`, install release candidate for ISIS version 7.2.0
30+
`conda install -c usgs-astrogeology/label/LTS`, install the latest LTS version of ISIS
3031

31-
Full list of supported versions including release candidates: [https://anaconda.org/usgs-astrogeology/isis3/files](https://anaconda.org/usgs-astrogeology/isis3/files)
32+
Related:
3233

33-
Info on maintaining your anaconda packages: [https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-pkgs.html](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-pkgs.html)
34+
- [List of ISIS versions on Conda](https://anaconda.org/usgs-astrogeology/isis/files)
35+
- [Maintaining your conda packages (conda docs)](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-pkgs.html)
36+
- [Semantic Versioning](https://github.com/DOI-USGS/ISIS3/tree/dev#Semantic-Versioning)
37+
- [Release Schedule](../../how-to-guides/software-management/isis-release-schedule.md)
38+
- [LTS Release Process](../../how-to-guides/software-management/lts-release-process.md)
39+
- [ISIS RFC8 - Long Term Support (LTS)](https://github.com/USGS-Astrogeology/ISIS3/discussions/4691)
40+
- [ISIS RFC14 - Changing ISIS Release Schedule](https://github.com/DOI-USGS/ISIS3/discussions/5731)
3441

35-
??? question "How do I keep two different versions of ISIS on my system and switch between them?"
3642

37-
An example of when this functionality may be useful is to test out a release candidate (RC) version of the ISIS3 software (if you have questions about RC’s, see the [Release Schedule][1] info). The solution is to use multiple environments. Follow the steps for installing ISIS using a new environment with a different name (e.g. `isis3.9` vs `isis3.9_RC`).
43+
??? question "How do I keep two different versions of ISIS on my system and switch between them?"
3844

39-
[1]: https://github.com/DOI-USGS/ISIS3/wiki/Release-Schedule
45+
Yes, use a different conda environment for each version. This is useful for testing a development version of ISIS. Follow the steps for installing ISIS using a new conda environment with a different name (e.g. `isis-lts` `isis7.2.0`, `isis-dev`).
46+
```sh
47+
# Create a conda environment, this name can be whatever you like
48+
conda create -n isis7.2.0
49+
conda activate isis7.2.0
50+
51+
# Install via conda, here you can specify which ISIS version you want to install.
52+
# See the previous question for more info on specifying the isis version.
53+
conda install -c usgs-astrogeology isis=7.2.0
54+
```
55+
*Note: you may need to [add channels](https://astrogeology.usgs.gov/docs/how-to-guides/environment-setup-and-maintenance/installing-isis-via-anaconda/#channels) before running `conda install [...]`.*
4056

4157
??? question "I Installed ISIS but I get “<app>: command not found” or similar error."
4258

@@ -81,6 +97,30 @@
8197
[6]: ../../how-to-guides/environment-setup-and-maintenance/isis-data-area.md#isis-spice-web-service
8298
[7]: ../../getting-started/using-isis-first-steps/locating-and-ingesting-image-data.md
8399

100+
??? question "Can I still use legacy versions of ISIS?"
101+
102+
### Supported ISIS Versions
103+
104+
LTS versions of ISIS are supported for 18 months from their release date ([RFC8](https://github.com/USGS-Astrogeology/ISIS3/discussions/4691), [RFC14](https://github.com/DOI-USGS/ISIS3/discussions/5731)). Versions before that are not officially supported or maintained, may no longer be hosted by USGS Astrogeology, and/or ***may no longer be installable***.
105+
106+
In particular, ISIS2 and Legacy ISIS3 distributions hosted on `isisdist.wr.usgs.gov` and `isisdist.astrogeology.usgs.gov` are no longer available.
107+
108+
### Legacy ISIS3 Versions
109+
110+
ISIS versions 3.6.1 and above are hosted on conda in the
111+
[usgs-astrogeology channel](https://anaconda.org/usgs-astrogeology/repo).
112+
Versions 3.6.1 to 3.9.1 are under the [isis3 package](https://anaconda.org/usgs-astrogeology/isis3/files),
113+
and versions 3.10.0 onwards are under the [isis package](https://anaconda.org/usgs-astrogeology/isis/files).
114+
115+
Older versions of ISIS may have different setup requirements and/or different scripts to facilitate installation. Check the `README.md` in the GitHub repo (under your version's tag), and/or the [Software Manuals](https://isis.astrogeology.usgs.gov) for more information.
116+
117+
ISIS versions back to 3.5.x may be viewed in the [ISIS GitHub source code repository](https://github.com/DOI-USGS/ISIS3/tree/v3.5.2) and the [ISIS Software Manuals](https://isis.astrogeology.usgs.gov/3.5.0/). The [Legacy Install Guide](https://isis.astrogeology.usgs.gov/8.2.0/documents/LegacyInstallGuide/index.html) details the method of installation, but ISIS distributions hosted on `isisdist.astrogeology.usgs.gov` are no longer available.
118+
119+
### Legacy ISIS2 Documentation
120+
121+
Some online ISIS2 documentation pages [remain here](https://isis.astrogeology.usgs.gov/Isis2/html/isis.html) for historical purposes, but they are unmaintained and unsupported. The [Wayback Machine](https://web.archive.org/web/20030613002511/http://isis.astrogeology.usgs.gov/) may help you find missing pages or broken links. As of 2025, the ISIS2 software does not appear to be installable; ISIS2 distributions are no longer hosted by USGS Astrogeology.
122+
123+
84124
???+ abstract "Additional Helpful Docs"
85125

86126
[Exhaustive list of ISIS commands](https://isis.astrogeology.usgs.gov/Application/index.html)

0 commit comments

Comments
 (0)