moved ale quickstart from ale docs to here #129
Conversation
|
will these contradict any existing docs? |
|
I don't think so, is there a particular point you're concerned about with contradiction?. The QuickStart does have small snippets of things that are explained in more detail in other docs. |
|
I guess I meant more if it's redundant to docs that exist, but a quick look seems like it doesn't |
| 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.
most of this is out of date, I would point to ISISDATA docs since it's the same.
| # 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 | ||
| ``` |
There was a problem hiding this comment.
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.
| ## `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.
We don't currently describe ALE load and loads in a beginner-friendly way in our docs.
This simple example for ALE load and loads in python is worth putting somewhere, and it could be followed with more detailed usage examples too. Other than that, the info here is duplicative/old and can be discarded.
I recommend we organize our info into 3 shorter (connected?) docs for ALE:
- Setup
- isd_generate (ALE scripting)
- load and loads (ALE in python)
I could also add the load/loads example to the Generating an ISD doc, and have one (sort of big) master doc.
|
|
||
| ----- | ||
|
|
||
| ??? info "How Each Driver Type Works - *NaifSpice, IsisSpice, IsisLabel, and Pds3Label*" |
There was a problem hiding this comment.
Similar to another comment they types should be IsisLabel + NaifSpice, IsisLabel + IsisSpice, and Pds3Label + NaifSpice. This is largely due to each mixin on its own doesn't constitute a complete driver
There was a problem hiding this comment.
I relabeled this section as "How each driver mixin works", since I describe the IsisLabel and NaifSpice mixins here in ways that apply to multiple driver types.
| @@ -0,0 +1,37 @@ | |||
| # ALE in Python - `load` and `loads` | |||
There was a problem hiding this comment.
We should be able to reference the ALE manual here as that has a good description of the functions. It looks like the ALE manuals aren't properly rendering
There was a problem hiding this comment.
I haven't yet seen the ALE manual properly populated - Every time I've seen it, it's seemed more like a very loose outline. That's why I've included this short example here for now, but it would be good if we could add a link out to the ALE manual in the future.
Licensing
This project is mostly composed of free and unencumbered software released into the public domain, and we are unlikely to accept contributions that are not also released into the public domain. Somewhere near the top of each file should have these words:
Sister PR to ALE