- The ISIS API reference is particularly useful if you are working on an application - or interested in using the ISIS library as a dependency. + If you're not familiar with working on the ISIS documentation, + these guides can help get you started.
| - - astrodiscuss + + Contributing ISIS Application Documentation | - Ask or answer questions on out community discussion board. + This how-to guide will take you through the steps required to write and modify the ISIS + application documentation. |
|---|---|
| - - GitHub Issues + + ISIS Application Examples Guide | - Comment on bug reports or feature requests from other users. + This how-to guide covers writing examples for ISIS application documentation. + Application examples are a specialized section of the ISIS application + documentation and require additional steps besides editing the application XML. |
| - - Requests for Comment + + General ISIS Documentation Guide | - Provide feedback on major changes proposed for ISIS. - | -
| - - ISIS Technical Committee - | -- Get involved in project governance. + This how-to guide covers writing documentation for this website. |
- The interface for ISIS applications and much of the ISIS documentation (including this - very page) are generated from XML files. These schemas are a helpful reference if you - are creating a new application, modifying application arguments, or writing documentation. + Testing is a crucial component of creating sustainable software and a requirement for all + code contributions to ISIS. These guides will help you run and modify the ISIS test suite.
| - - Downloading the Source Code - | -- How to pull the source code from GitHub. - | -
|---|---|
| - - Dependency Management + + Writing Tests Using GTest and CTest | - How to download the dependencies required to build ISIS. + As of version 3.6, ISIS uses googletest and CTest for testing. This how-to guide will + walk you through the steps required to write tests using the new frameworks. It also + covers the steps needed to convert ISIS applications to the new callable format. |
| - - Building + + ISIS Test Data | - How to build ISIS once you have the source code and dependencies downloaded. + Legacy Makefile based tests in ISIS use a input and truth data to confirm that the + aplications produce the proper output. This page explains how to download these + files required to run the ISIS test suite. |
| - - Running the Test Suite + + Legacy Makefile Tests Guide | - How to run the ISIS test suite once ISIS is built. + This documents describes how legacy Makefile tests work. Contributors are required + to use the new googletest system for new tests, but there are rare situations where + existing legacy Makefile tests need to be updated and cannot be converted. |
- If you're not familiar with working on the ISIS documentation, - these guides can help get you started. + These resources are useful for maintainers and outline the processes that + support the broader user and contributor community.
| - - Basic ISIS3 Programming - | -- hese exercises will walk you through the basics of ISIS applications. - | -
|---|---|
| - - Advanced ISIS Programming Exercises + + Release Process | - These exercises give you the chance to explore more yourself and interact with more - complex components of the ISIS API. + This guide goes through all the steps required to create both release candidates + and full releases. |
- Testing is a crucial component of creating sustainable software and a requirement for all - code contributions to ISIS. These guides will help you run and modify the ISIS test suite. + The ISIS API reference is particularly + useful if you are working on an application or interested in using the ISIS library + as a dependency.
-| - - Adding a New Feature - | -- This document will walk you through what's needed when adding a new feature to ISIS. - If there is something you think is missing in ISIS this will walk you through the - steps needed to add it. - | -
|---|---|
| - - Modifying an Existing Feature - | -- Modifying an existing feature is slightly more complex than adding a new feature to ISIS. - This document will walk you through what is different when you are building from an - existing feature instead of something new. - | -
- These resources are useful for maintainers and outline the processes that - support the broader user and contributor community. + The interface for ISIS applications and much of the ISIS documentation (including this + very page) are generated from XML files. These schemas are a helpful reference if you + are creating a new application, modifying application arguments, or writing documentation.
| - - Adding a New Feature + + ISIS Application XML Schema | - This document will walk you through what's needed when adding a new feature to ISIS. - If there is something you think is missing in ISIS this will walk you through the - steps needed to add it. + This schema defines the ISIS application XML format. This includes the applications + documentation and all of the application arguments. |
|---|---|
| - - Modifying an Existing Feature + + ISIS Web Documentation XML Schema | - Modifying an existing feature is slightly more complex than adding a new feature to ISIS. - This document will walk you through what is different when you are building from an - existing feature instead of something new. + This schema defines the XML documentation format used to generate this documentation. + If you want to make a change to the ISIS website documentation, then you will need to + reference this schema for your changes. |
- The first step for all code contributions to ISIS is a GitHub issue. Look at the open - enhancement requests to see what other members of the community have asked for and maybe - there will be something you are interested in too. It you just want to get started with - contributing code; issues labeled with Good First Issue are an excellent place for - newcomers to start. + The first step for all code contributions to ISIS is a GitHub issue. If you want to get started with + contributing code, then start with the currently open issues.
| - - astrodiscuss + + Enhancement Requests | - Ask or answer questions on out community discussion board. + Look at the open enhancement requests to see what other members of the community have + asked for and maybe there will be something you are interested in too. |
|---|---|
| - - GitHub Issues + + Good First Issues | - Comment on bug reports or feature requests from other users. - | -
| - - Requests for Comment - | -- Provide feedback on major changes proposed for ISIS. - | -
| - - ISIS Technical Committee - | -- Get involved in project governance. + Issues labeled with Good First Issue have been idenditifed by other contributors as + places where newcomers can get started. |
- If you are interested in what other contributors are working on, look at the GitHub - pull requests that are currently open. Even if you do not have write permissions to the + If you are interested in what other contributors are working on, look at the + GitHub pull requests + that are currently open. Even if you do not have write permissions to the repository, input and testing on pull requests are always appreciated.
-| - - Downloading the Source Code - | -- How to pull the source code from GitHub. - | -
|---|---|
| - - Dependency Management - | -- How to download the dependencies required to build ISIS. - | -
| - - Building - | -- How to build ISIS once you have the source code and dependencies downloaded. - | -
| - - Running the Test Suite - | -- How to run the ISIS test suite once ISIS is built. - | -
- Now that you have some experience running applications and working with data, you may have some questions - about how exactly ISIS works. -
-- On this page you will find a wide variety of resources explaining the specific details of how ISIS works. Many - components of ISIS were created in response to the needs of specific data sets. So, there are a wide variety of - processing paths and customizations that you can leverage when creating a workflow. + Now that you have some experience running applications and working with data, understanding the finer details + about how ISIS works can make you a more efficient and powerful ISIS user. + On this page you will find resources explaining individual components of ISIS. +
- These resources are useful regardless of what you are using ISIS for. They provide details about fundamental components of ISIS that + These resources provide details about fundamental components of ISIS that are used across applications.
| - Description of Astrogeology Science Center's ISIS release cadence and expected dates of future releases. + A description of ISIS's release cadence and expected dates of future releases. | @@ -281,7 +279,7 @@ Deborah Lee Soltesz Backward Compatibility Policy- Policy for ISIS backward compatibility for users. + What users can expect to still work after updating to a new version of ISIS. | diff --git a/isis/src/docsys/build/UserInspire.xsl b/isis/src/docsys/build/UserInspire.xsl index 26eb1d8b9c..f591d7397b 100644 --- a/isis/src/docsys/build/UserInspire.xsl +++ b/isis/src/docsys/build/UserInspire.xsl @@ -97,12 +97,16 @@ Deborah Lee Soltesz|
- User Get Inspired + Get Inspired by Other ISIS Users- Let's zoom out and look at what community members have used ISIS to do in the past. These papers, talks and + These papers, talks and demonstrations are examples that you can draw inspiration from and model your own workflows after. ++ If you have examples you would like to add to this page, submit a pull request on + GitHub! + |
Home @@ -135,8 +139,8 @@ Deborah Lee Soltesz Using the Community Sensor Model with Planetary Data | - A talk given by Jesse Mapel at the OpenPlanetary Lunch covering the Community Sensor Model API and the USGS ASC's implementation of it and - supported cameras as of October 2021. + A talk given by Jesse Mapel at an OpenPlanetary Lunch covering the Community Sensor Model API, the USGS ASC's implementation of it, + supported cameras as of October 2021, and how to use them in ISIS. |
- User Learn More + Learn More About Using ISIS- At this point you should have ISIS installed and have run your first commands, meaning you are officially an ISIS user, congratulations! + At this point you have installed ISIS and executed your first applications, meaning you are officially an ISIS user, congratulations! - On this page you will find information and resources to help you further your skills as an ISIS user as well as learn some of the history - of ISIS and its predecessors. The tutorials and explanations here will help you personalize the operation of your ISIS install and the walk - you through the basic steps of processing data through ISIS to create analysis ready data or control networks from various mission data. + On this page you will find information and resources to help you further your skills as an ISIS user. + The tutorials and explanations here will walk you through the basic steps of working with data in ISIS + and provide information about how to customize your ISIS install. |
@@ -116,47 +116,6 @@ Deborah Lee Soltesz
-
- - About-- These resources contain information about ISIS's history, personalization capabilities, and the entire catalog of applications ISIS contains. - -
- Intermediate Tutorials+Intermediate Resources- These tutorials walk you through intermediate image processing methods that are useful across a variety of workflows as well - as high-level explanations of some cartographic concepts. + These resources are more complex than the introductory materials and are useful across workflows in ISIS.
+
Mission Specific ISIS Processing- These tutorials walk you through the steps required to map project a variety of the datasets supported by ISIS. + These tutorials take you through all the steps required to process raw image data to map projected products for specific datasets. + Each tutorial is accompanied by an overview and references for the mission and instrument that created the dataset. |
What is ISIS?- The Integrated System for Imagers and Spectrometers (ISIS) is a free, - specialized, digital image processing software package developed by - the USGS for NASA. ISIS key feature is the ability to place many - types of data in the correct cartographic location, enabling disparate - data to be co-analyzed. ISIS also includes standard image processing - applications such as contrast, stretch, image algebra, filters, and - statistical analysis. ISIS can process two-dimensional images as well - as three-dimensional cubes derived from imaging spectrometers. The - production of USGS topographic maps of extraterrestrial landing sites - relies on ISIS software. ISIS is able to process data from NASA and - International spacecraft missions including Lunar Orbiter, Apollo, - Voyager, Mariner 10, Viking, Galileo, Magellan, Clementine, Mars - Global Surveyor, Cassini, Mars Odyssey, Mars Reconnaissance Orbiter, - MESSENGER, Lunar Reconnaissance Orbiter, Chandrayaan, Dawn, Kaguya, and - New Horizons. + Integrated Software for Imagers and Spectrometers (ISIS) is free and + open-source software (FOSS) developed by the USGS Astrogeology + Science Center for NASA and the planetary community. ISIS is a + fundamental tool for processing raw archival data into analysis ready + products and includes standard image processing tools such as + contrast, stretch, image algebra, filters, and statistical analysis. + However, ISIS's key feature is the ability to place different types of + data in the correct cartographic locations on extraterrestrial bodies. + The cartographically located data can then be used to create archives, + topographic or cartographic maps, digital elevation models, and other + scientific products. Supporting Planetary Space Missions- The ISIS software is a valuable resource for planetary missions that - require systematic data processing, products for planning, and research - and analysis of derived data products. By using ISIS, missions can - leverage millions of dollars of software development that NASA has paid - for. However, before the power of ISIS can be applied to an instrument, - a camera model, and custom programs to ingest mission-specific ancillary - data are necessary. Once an instrument is added to ISIS, it can support - data processing pipelines, radiometric calibration, photometric - calibration, band-to-band registration of multispectral data, - ortho-rectification, construction of scientifically accurate and - cosmetically pleasing mosaics, generation of control networks solutions - and creation of topographic models. + ISIS is a valuable resource for planetary missions that require + systematic data processing, products for planning, and research and + analysis of derived data products. Support for a mission is added to + ISIS by creating sensor models, tools for ingesting mission-specific + ancillary data, and optional tools for calibrating mission data. Once + a mission is supported, data from that mission can be used with the + full suite of processing and analysis tools in ISIS. ISIS supports + data from NASA and International spacecraft missions including Lunar + Orbiter, Apollo, Voyager, Mariner 10, Viking, Galileo, Magellan, + Clementine, Mars Global Surveyor, Cassini, Mars Odyssey, Mars + Reconnaissance Orbiter, MESSENGER, Lunar Reconnaissance Orbiter, + Chandrayaan, Dawn, Kaguya, and New Horizons. ISIS Users@@ -68,7 +64,7 @@ InstallationLearn More
|