From 0b1796a4e711178605610baeb3824f8817bab790 Mon Sep 17 00:00:00 2001 From: Jacob Cain Date: Mon, 3 Feb 2025 08:18:43 -0800 Subject: [PATCH 1/4] moved ale quickstart from ale docs to here --- .../using-ale/ale-quickstart.md | 54 +++++++++++++++++++ mkdocs.yml | 1 + 2 files changed, 55 insertions(+) create mode 100644 docs/getting-started/using-ale/ale-quickstart.md diff --git a/docs/getting-started/using-ale/ale-quickstart.md b/docs/getting-started/using-ale/ale-quickstart.md new file mode 100644 index 0000000..ddb80ac --- /dev/null +++ b/docs/getting-started/using-ale/ale-quickstart.md @@ -0,0 +1,54 @@ +# ALE Quick Start + +This document provides a set of steps to get setup for generating Image Support +Data (ISD) for an image. + +## Installation + +Install ALE with conda. (If you don't have conda, [get it via miniforge](https://conda-forge.org/download/).) +```sh + conda create -n ale + conda activate ale # Activate your environment every time you need to use ALE. + conda install -c conda-forge ale +``` + +## Data + +Planetary imagery is not archived with sufficient data to generate an ISD +from only the image and its label. ALE currently supports two supplementary data +sources: ISIS cubes with attached SPICE, and NAIF SPICE Kernels. + +For ISIS cubes with attached SPICE (the +[`spiceinit`](https://isis.astrogeology.usgs.gov/Application/presentation/Tabbed/spiceinit/spiceinit.html) +application has been run on them) then ALE will use the data embedded in the +cube file. + +For PDS3 images or ISIS cubes without attached +SPICE, download the required NAIF SPICE Kernels for your +image. We reccomend using the metakernels provided in the +[PDS kernel archives](https://naif.jpl.nasa.gov/naif/data_archived.html). +Specify the path for ALE to search for metakernels via the +`ALESPICEROOT` environment variable. This should be set to the directory where +you have the PDS kernel archives downloaded. An example structure would be + +* $ALESPICEROOT + * mro-m-spice-6-v1.0 + * dawn-m_a-spice-6-v1.0 + * mess-e_v_h-spice-6-v1.0 + +See `ale.base.data_naif.NaifSpice.kernels` for more information about how to +specify NAIF SPICE kernels. + +## `load` and `loads` + +The `ale.drivers.load` and `ale.drivers.loads` functions are +the main interface for generating ISDs. Simply pass them the path to your image +file/label and they will attempt to generate an ISD for it. + +```py +import ale + +image_label_path = "/path/to/my/image.lbl" +isd_string = ale.loads(image_label_path) +``` + diff --git a/mkdocs.yml b/mkdocs.yml index 250c3b2..f0bde43 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -49,6 +49,7 @@ nav: - Exporting ISIS Data: getting-started/using-isis-first-steps/exporting-isis-data.md - ISIS FAQ: getting-started/using-isis-first-steps/isis-faq.md - Using Ale: + - ALE Quickstart: getting-started/using-ale/ale-quickstart.md - Generating an ISD: getting-started/using-ale/isd-generate.md - Archive: - Demos and Workshops: getting-started/archive/isis-demos-and-workshops.md From 137c236c3b6ebc5de041dd45c88c90daeb805ce9 Mon Sep 17 00:00:00 2001 From: Jacob Cain Date: Mon, 3 Feb 2025 08:23:10 -0800 Subject: [PATCH 2/4] spelling recommend --- docs/getting-started/using-ale/ale-quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/getting-started/using-ale/ale-quickstart.md b/docs/getting-started/using-ale/ale-quickstart.md index ddb80ac..d092418 100644 --- a/docs/getting-started/using-ale/ale-quickstart.md +++ b/docs/getting-started/using-ale/ale-quickstart.md @@ -25,7 +25,7 @@ cube file. For PDS3 images or ISIS cubes without attached SPICE, download the required NAIF SPICE Kernels for your -image. We reccomend using the metakernels provided in the +image. We recommend using the metakernels provided in the [PDS kernel archives](https://naif.jpl.nasa.gov/naif/data_archived.html). Specify the path for ALE to search for metakernels via the `ALESPICEROOT` environment variable. This should be set to the directory where From 5c14fa3799652d0575018d8a1131a88d62b57448 Mon Sep 17 00:00:00 2001 From: Jacob Cain Date: Mon, 3 Feb 2025 08:40:22 -0800 Subject: [PATCH 3/4] spelling --- docs/concepts/isis-fundamentals/command-line-usage.md | 2 +- docs/getting-started/index.md | 2 +- docs/how-to-guides/index.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/concepts/isis-fundamentals/command-line-usage.md b/docs/concepts/isis-fundamentals/command-line-usage.md index 77799d4..fb9cbf2 100644 --- a/docs/concepts/isis-fundamentals/command-line-usage.md +++ b/docs/concepts/isis-fundamentals/command-line-usage.md @@ -405,7 +405,7 @@ The values are case insensitive. That is, Yes, YES, True, T, etc. work as well. ## Inclusive and Exclusive Parameters -The GUI has the ability to include or exclude parameters via stipling (graying out parameters). The application programs will throw an error if certain parameters are incorrectly included or excluded when executing a command in command line mode. See the following _grid_ example, and notice the user errors: +The GUI has the ability to include or exclude parameters via stippling (graying out parameters). The application programs will throw an error if certain parameters are incorrectly included or excluded when executing a command in command line mode. See the following _grid_ example, and notice the user errors: ``` grid from=0145r_cal.cub to=gridtest.cub baseline=10 basesamp=20 diff --git a/docs/getting-started/index.md b/docs/getting-started/index.md index 5f951e8..50a59fa 100644 --- a/docs/getting-started/index.md +++ b/docs/getting-started/index.md @@ -51,7 +51,7 @@ Concrete things your tutorial needs: or [Project Preference File](../concepts/isis-fundamentals/preference-dictionary.md#project-preference-file) for more info on custom ISISPreferences files. ``` -- [ ] If your tutorial has data, use generative data or data that is in the repo. Avoid external data dependencies. Before data is committed into the repo, check if [existing data can be re-used](https://github.com/DOI-USGS/asc-public-docs/tree/main/docs/assets). If new data needs to be committed, minimize the size so as not to increase the data burden. +- [ ] If your tutorial has data, use generative data or data that is in the repo. Avoid external data dependencies. Before data is committed into the repo, check if [existing data can be reused](https://github.com/DOI-USGS/asc-public-docs/tree/main/docs/assets). If new data needs to be committed, minimize the size so as not to increase the data burden. - [ ] Make the objectives clear in the title. Also, clarify the tutorial with a summary of objectives. See the [git repo](https://code.usgs.gov/astrogeology/asc-public-docs) for more in-depth info on how to contribute new docs. diff --git a/docs/how-to-guides/index.md b/docs/how-to-guides/index.md index 9ef1490..a378c3c 100644 --- a/docs/how-to-guides/index.md +++ b/docs/how-to-guides/index.md @@ -1,6 +1,6 @@ # How-To Guides -How-to guides are much like recipes in a recipe book. Write how-to docs to solve specific problems quickly, sometimes copy-pastable. Think of how-to guides as pre-emptive StackOverflow-like problems. +How-to guides are much like recipes in a recipe book. Write how-to docs to solve specific problems quickly, sometimes copy-pastable. Think of how-to guides as preemptive StackOverflow-like problems. ## For Readers From 6362a3f29924f32589c5b445a69e0c4c49017c53 Mon Sep 17 00:00:00 2001 From: Jacob Cain Date: Mon, 3 Feb 2025 08:57:06 -0800 Subject: [PATCH 4/4] spelling ignore --- docs/how-to-guides/image-processing/general-utility-with-fx.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/how-to-guides/image-processing/general-utility-with-fx.md b/docs/how-to-guides/image-processing/general-utility-with-fx.md index 59b04c5..de31b62 100644 --- a/docs/how-to-guides/image-processing/general-utility-with-fx.md +++ b/docs/how-to-guides/image-processing/general-utility-with-fx.md @@ -157,7 +157,7 @@ based on the camera model information stored in the image labels: - pha, phal, phac - ina, inal, inac - - ema, emal, emac + - ema, emal, emac - lat - lon - radius