From a923240878007790ab8cd24ea1aa4f548d558e38 Mon Sep 17 00:00:00 2001 From: Lauren Adoram-Kershner <42873279+ladoramkershner@users.noreply.github.com> Date: Wed, 16 Mar 2022 11:19:07 -0700 Subject: [PATCH] Reformat Homepage and creating place holder landing pages (#4839) * Reformat Homepage; place holder landing pages * Updating landing pages * updating landing pages and BuildDocs.cmake --- isis/cmake/BuildDocs.cmake | 14 +- isis/src/docsys/build/UserExplore.xsl | 490 ++++++++++++++++++++++++++ isis/src/docsys/build/UserInspire.xsl | 380 ++++++++++++++++++++ isis/src/docsys/build/UserLearn.xsl | 480 +++++++++++++++++++++++++ isis/src/docsys/build/UserStart.xsl | 421 ++++++++++++++++++++++ isis/src/docsys/build/homepage.xml | 200 +++++++++-- 6 files changed, 1954 insertions(+), 31 deletions(-) create mode 100644 isis/src/docsys/build/UserExplore.xsl create mode 100644 isis/src/docsys/build/UserInspire.xsl create mode 100644 isis/src/docsys/build/UserLearn.xsl create mode 100644 isis/src/docsys/build/UserStart.xsl diff --git a/isis/cmake/BuildDocs.cmake b/isis/cmake/BuildDocs.cmake index 6c3b83ed6e..139dd93a29 100644 --- a/isis/cmake/BuildDocs.cmake +++ b/isis/cmake/BuildDocs.cmake @@ -67,7 +67,7 @@ endfunction(copy_app_docs_info) function(build_upper_level) # Make new (empty) output folders - set(newFolders UserDocs AboutIsis General Guides Installation TechnicalInfo) + set(newFolders UserDocs UserStart UserLearn UserExplore UserInspire AboutIsis General Guides Installation TechnicalInfo) foreach(f ${newFolders}) file(MAKE_DIRECTORY "${docInstallFolder}/${docVersion}/${f}") endforeach() @@ -193,6 +193,18 @@ function(build_documents_folder) # USER DOCS TOC execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} menuPath \"../\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/UserDocs/index.html ${XALAN_INFILE_OPTION} ${doctocPath} ${XALAN_XSL_OPTION} ${docBuildFolder}/build/UserDocs.xsl) + # USER GETTING STARTED DOCS TOC + execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} menuPath \"../\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/UserStart/index.html ${XALAN_INFILE_OPTION} ${doctocPath} ${XALAN_XSL_OPTION} ${docBuildFolder}/build/UserStart.xsl) + + # USER LEARN MORE DOCS TOC + execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} menuPath \"../\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/UserLearn/index.html ${XALAN_INFILE_OPTION} ${doctocPath} ${XALAN_XSL_OPTION} ${docBuildFolder}/build/UserLearn.xsl) + + # USER EXPLORE IN DETAIL DOCS TOC + execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} menuPath \"../\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/UserExplore/index.html ${XALAN_INFILE_OPTION} ${doctocPath} ${XALAN_XSL_OPTION} ${docBuildFolder}/build/UserExplore.xsl) + + # USER GET INSPIRED DOCS TOC + execute_process(COMMAND ${XALAN} ${XALAN_PARAM_OPTION} menuPath \"../\" ${XALAN_OUTFILE_OPTION} ${docInstallFolder}/${docVersion}/UserInspire/index.html ${XALAN_INFILE_OPTION} ${doctocPath} ${XALAN_XSL_OPTION} ${docBuildFolder}/build/UserInspire.xsl) + endfunction(build_documents_folder) diff --git a/isis/src/docsys/build/UserExplore.xsl b/isis/src/docsys/build/UserExplore.xsl new file mode 100644 index 0000000000..3449466d40 --- /dev/null +++ b/isis/src/docsys/build/UserExplore.xsl @@ -0,0 +1,490 @@ + + + + + + + + + + + + + + + + + + + + + + + + + USGS Isis: Explore in Detail User Documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + USGS
+ + +

+ ISIS Documentation

+ +
+ + + + + + + +
+

+ User Explore in Detail +

+

+ 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. +

+
+ Home +
+ + + + +
+

General Purpose

+

+ These resources are useful regardless of what you are using ISIS for. They provide details about fundamental components of ISIS that + are used across applications. +

+ + + + + + + +
+
+

About ISIS Cubes

+
+ ISIS Cube Format
+
+ Understanding Bit Types
+
+ Core Base and Multipliers
+
+ Special Pixels
+
+ Label Dictionary
+
+ Logical Cube Format Guide
+
+
+
+

About ISIS Applications

+
+ Command Line Reference
+
+ Glossary
+
+ Error Handling Facility
+
+ Error Dictionary
+
+ Preference Dictionary
+
+ Session Log Explanation
+
+
+ + + + + + +
+

Task Specific Guides

+

+ These resources apply to specific applications or specialized processing methods. They provide particulars about how to work with individual + applications or how specialized data is formatted. +

+ + + + + + + + + + +
+
+

About Specific Applications

+
+ fx Guide
+
+ autoseed Guide
+
+ SPICE in ISIS
+
+ Pattern Matching Guide
+
+ autoreg Guide
+
+
+
+

About Specialized Methods

+
+ Photogrammetry in ISIS
+
+ Image Registration
+
+ Multi-Instrument Registration
+
+ Jigsaw Overview
+
+
+
+

Specialized Method References

+
+ Control Network Reference
+
+ Map Definition Reference
+
+
+ + + +
+

Policies

+

+ These documents describe various policies about what users can expect when using ISIS. +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + Release Schedule + + Description of Astrogeology Science Center's ISIS release cadence and expected dates of future releases. +
+ + Backward Compatibility Policy + + Policy for ISIS backward compatibility for users. +
+ + Deprecation Policy + + ISIS functionality deprecation procedure. +
+ + User Rights + + Licensing, copyright, distribution, and warranty information. +
+ + Disclaimers + + Standard legalese regarding usage, trademarks, and privacy. +
+ + + + + + + + +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + (, ) + +
+ + +
+ + + + + + + + + + + + + + + + + + + (, ) + + +
+ + + + + + + + + + + + + + + + + + + | + + + + + +
+
+
+ +
+ +
+ + + + + + + + + + + + +

+ + + +
+ +
+ + (, ) + +

+
+ + + + + + + + +

+ + + + + + + + (, )
+
+ +
+ + + + + + + + + + + + + + + + + + + | + + +

+ +
+
+
+ +
+ +
+ + +
diff --git a/isis/src/docsys/build/UserInspire.xsl b/isis/src/docsys/build/UserInspire.xsl new file mode 100644 index 0000000000..51f5042931 --- /dev/null +++ b/isis/src/docsys/build/UserInspire.xsl @@ -0,0 +1,380 @@ + + + + + + + + + + + + + + + + + + + + + + + + + USGS Isis: Get Inspired User Documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + USGS
+ + +

+ ISIS Documentation

+ +
+ + + + + + + +
+

+ User Get Inspired +

+

+ Let's zoom out and look at what community members have used ISIS to do in the past. These papers, talks and + demonstrations are examples that you can draw inspiration from and model your own workflows after. +

+
+ Home +
+ + + + +
+

Talks

+ + + + + + + + + + + +
+ + + + A presentation given by Kris Becker concerning the motivation and work done to create the findfeatures application. Coresponding abstract + can be found here +
+ + Using the Community Sensor Model with Planetary Data + + A talk given by Jesse Mapel at the OpenPlanetary Lunch +
+ + + + + + +
+

Papers

+

+ These documents will take you through a small tutorial to get you running your first few applications and explain some of the basics of ISIS. + They will also give you a brief introduction to the planetary data ecosystem and how you can find data to process in ISIS. +

+ + + + + + + + + + + +
+ + Introduction to ISIS + + ISIS is typically run through the command-line interface (CLI) or a graphical user interface (GUIs). All application have GUIs, but not all + application can be entirely run from the command line. The interactive ISIS applications are GUI only and are used to visualize and edit + specialized data, these applications all start with “q” (”qview”, “qmos”, etc.). +
+ + Locating and Ingesting Image Data + + Descritpionnnn, description! +
+ + + + + + +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + (, ) + +
+ + +
+ + + + + + + + + + + + + + + + + + + (, ) + + +
+ + + + + + + + + + + + + + + + + + + | + + + + + +
+
+
+ +
+ +
+ + + + + + + + + + + + +

+ + + +
+ +
+ + (, ) + +

+
+ + + + + + + + +

+ + + + + + + + (, )
+
+ +
+ + + + + + + + + + + + + + + + + + + | + + +

+ +
+
+
+ +
+ +
+ + +
diff --git a/isis/src/docsys/build/UserLearn.xsl b/isis/src/docsys/build/UserLearn.xsl new file mode 100644 index 0000000000..62ffbbf204 --- /dev/null +++ b/isis/src/docsys/build/UserLearn.xsl @@ -0,0 +1,480 @@ + + + + + + + + + + + + + + + + + + + + + + + + + USGS Isis: Learn More User Documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + USGS
+ + +

+ ISIS Documentation

+ +
+ + + + + + + +
+

+ User Learn More +

+

+ At this point you should have ISIS installed and have run your first commands, 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. +

+
+ Home +
+ + + + +
+

About

+

+ These resources contain information about ISIS's history, personalization capabilities, and the entire catalog of applications ISIS contains. +

+ + + + + + + + + + + + + + + +
+ + ISIS History + + ISIS has been in development since the early 1970’s, just after the Astrogeology Science Center (ASC) involvement with the Apollo mission. Learn + more about the origin of this foundational software! +
+ + Environment and Preference Setup + + This document describes how to setup your Unix environment to run ISIS and manage ISIS preference files for multiple users or installations. +
+ + Software Manual + + This document provides detailed documentation for every application in ISIS. If you are looking for an application to perform a specific task, + this is a great place to start. +
+ + + + + + +
+

Intermediate Tutorials

+

+ 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. +

+ + + + + + + + + + + +
+

General Image Processing

+

+ + The Power of Spatial Filters
+ Description of spatial filter applications in ISIS and common use cases.
+ + Removing Striping Noise from Image Data
+ Procedures for removing horizontal or vertical noise in an image. +

+
+

Cartography

+

+ + Learning About Map Projection
+ Description of the types of Projections supported by ISIS.
+ + Camera Geometry
+ Description of camera geometry within ISIS and example of ISIS applications that have access to this geometry. +

+
+

Interactive Tools

+

+ + Qnet
+ An interactive tool to create and edit control networks.
+ + Qtie
+ An interactive tool to update the camer pointing (SPICE) of a single cube.
+ + Qview
+ An interactive tool to display and analyze cubes.
+ + Qmos
+ An interactive tool to display and analyze cube footprints. +

+
+ + + +
+

Mission Specific ISIS Processing

+

+ These tutorials walk you through the steps required to map project a variety of the datasets supported by ISIS. +

+ + + + + + + + + + + +
+

Moon

+
+
Lunar Reconnaissance Orbiter
+
+ MiniRF
+
+
+

Mars

+
+
+ Mars Reconnaissance Orbiter
+
+ High Resolution Imaging Science Experiment (HiRise)
+
+ Context Imager (CTX)
+
+ Mars Global Surveyor
+
+ Mars Orbiter Camera (MOC)
+
+ Mars Viking Orbiter
+
+ Narrow Angle Camera (NAC) and Wide Angle Camera (WAC)
+
+
+

Other

+
+
+ Cassini-Huygens
+
+ Imaging Science Subsystem(ISS)
+
+ Radar
+
+ Visual and Infrared Mapping Spectrometer (VIMS)
+
+
+ + + + + + + + +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + (, ) + +
+ + +
+ + + + + + + + + + + + + + + + + + + (, ) + + +
+ + + + + + + + + + + + + + + + + + + | + + + + + +
+
+
+ +
+ +
+ + + + + + + + + + + + +

+ + + +
+ +
+ + (, ) + +

+
+ + + + + + + + +

+ + + + + + + + (, )
+
+ +
+ + + + + + + + + + + + + + + + + + + | + + +

+ +
+
+
+ +
+ +
+ + +
diff --git a/isis/src/docsys/build/UserStart.xsl b/isis/src/docsys/build/UserStart.xsl new file mode 100644 index 0000000000..4bda7a94fb --- /dev/null +++ b/isis/src/docsys/build/UserStart.xsl @@ -0,0 +1,421 @@ + + + + + + + + + + + + + + + + + + + + + + + + + USGS Isis: Getting Started User Documentation + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ +
+ + + USGS
+ + +

+ ISIS Documentation

+ +
+ + + + + + + +
+

+ User Getting Started +

+

+ Welcome! We are very glad you are joining the community! +

+

+ On this page you will find resources to help you start using the ISIS software; how to install, running your + first command, and a short tutorial to get you familiar with ISIS. This page will also direct you to some + resources where you can seek help from fellow community members. +

+
+ Home +
+ + + + +
+

Installation

+

+ ISIS is a free and open-source software (FOSS) that has been in use by the planetary science and data community for decades. These documents + describe how to install the latest version of ISIS and some legacy versions too. +

+ + + + + + + + + + + +
+ + ISIS Installation Guide + + Instructions on downloading and installing ISIS 3.6 and later. +
+ + Legacy ISIS3 Installation Guide + + instructions on downloading and installing versions of ISIS3 3.5.2 and earlier. +
+ + + + + + +
+

Introductory Tutorials

+

+ These documents will take you through a small tutorial to get you running your first few applications and explain some of the basics of ISIS. + They will also give you a brief introduction to the planetary data ecosystem and how you can find data to process in ISIS. +

+ + + + + + + + + + + +
+ + Introduction to ISIS + + ISIS is typically run through the command-line interface (CLI) or a graphical user interface (GUIs). All application have GUIs, but not all + application can be entirely run from the command line. The interactive ISIS applications are GUI only and are used to visualize and edit + specialized data, these applications all start with “q” (”qview”, “qmos”, etc.). +
+ + Locating and Ingesting Image Data + + Overview of planetary datasets serving locations and descriptions of how to download and work with said data in ISIS. +
+ + + +
+

Support

+

+ Join the community of ISIS users, find help, and share your successes! +

+ + + + + + + + + + + + +
+ + Github Issues + + Here you can post bug reports or feature requests and find out about the status of bugs posted by other users. +
+ + AstroDiscuss + + A community board where we collect our online knowledge base, provide release announcements, and provide user support. If you need help, + want to get the latest news, or just want to learn more and interact with other ISIS3 users come say hello! +
+ + + + + + + + +
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + (, ) + +
+ + +
+ + + + + + + + + + + + + + + + + + + (, ) + + +
+ + + + + + + + + + + + + + + + + + + | + + + + + +
+
+
+ +
+ +
+ + + + + + + + + + + + +

+ + + +
+ +
+ + (, ) + +

+
+ + + + + + + + +

+ + + + + + + + (, )
+
+ +
+ + + + + + + + + + + + + + + + + + + | + + +

+ +
+
+
+ +
+ +
+ + +
diff --git a/isis/src/docsys/build/homepage.xml b/isis/src/docsys/build/homepage.xml index 1a41d138aa..1f86ce9379 100644 --- a/isis/src/docsys/build/homepage.xml +++ b/isis/src/docsys/build/homepage.xml @@ -23,40 +23,180 @@
-

Welcome

+

What is ISIS?

- This is the home page for ISIS, a digital image processing software - package. The focus of the software is to manipulate imagery collected - by current and past NASA and International planetary missions sent - throughout our Solar System. + 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.

-

Announcements

-
-
- -
-
-

Request for comments

+

Supporting Planetary Space Missions

- Major changes to how ISIS works are now handled through Requests for Comment (RFCs). - These are a venue for the user community to voice their opinions on how they would - like the software to work. - Currently open RFCs can be found on the - ISIS Github. + 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.

-

Popular Destinations

- + +

ISIS Users

+ + + + + + + + + +
+

Getting Started

+
    +
  • + Installation +
  • +
  • + Tutorials +
  • +
  • + Support +
  • +
+
+

Learn More

+
    +
  • + History of ISIS +
  • +
  • + Environment and Preference Setup +
  • +
  • + Software Manual +
  • +
  • + Intermediate Tutorials +
  • +
  • + Mission Specific ISIS Processing +
  • +
+
+

Explore in Detail

+
    +
  • + ISIS Cube Format +
  • +
  • + Command Line Reference +
  • +
  • + SPICE in ISIS +
  • +
  • + Specialized Method Conceptual Workflows +
  • +
  • + Policies +
  • +
  • + ... and More! +
  • +
+
+

Get Inspired

+
    +
  • + White papers +
  • +
  • + Presentations +
  • +
  • + Talks +
  • +
+
+ +

ISIS Contributors

+ + + + + + + + +
+

Getting Started

+
    +
  • + Start Contributing +
  • +
  • + How to Build ISIS +
  • +
  • + Modifying a feature +
  • +
  • + Adding a feature +
  • +
  • + Adding a feature +
  • +
  • + Programming Exercises +
  • +
+
+

Explore in Detail

+
    +
  • + Developer API Reference +
  • +
  • + XML Schema +
  • +
  • + Documentation and Testing How-Tos +
  • +
  • + Policies +
  • +
+
+

Get Inspired

+
    +
  • + Github "good first" issues +
  • +
  • + Github "enhancement" issues +
  • +
  • + Github Pull Requests +
  • +
+