-
Notifications
You must be signed in to change notification settings - Fork 10
moved ale quickstart from ale docs to here #129
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
base: main
Are you sure you want to change the base?
Changes from 4 commits
0b1796a
137c236
5c14fa3
6362a3f
d9284a0
c56aad0
5130b03
5c01a66
03f8768
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. most of this is out of date, I would point to ISISDATA docs since it's the same. |
||
|
||
## `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) | ||
``` | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We don't currently describe ALE This simple example for ALE I recommend we organize our info into 3 shorter (connected?) docs for ALE:
I could also add the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
it might not completely be overlapping with other docs, but I feel the "generate ISD" docs would be more useful? Way we should prefer that.