Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

moved ale quickstart from ale docs to here #129

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/concepts/isis-fundamentals/command-line-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion docs/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
54 changes: 54 additions & 0 deletions docs/getting-started/using-ale/ale-quickstart.md
Original file line number Diff line number Diff line change
@@ -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 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
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)
```

Original file line number Diff line number Diff line change
Expand Up @@ -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 <!-- codespell:ignore emac -->
- lat
- lon
- radius
Expand Down
2 changes: 1 addition & 1 deletion docs/how-to-guides/index.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading