@@ -9,6 +9,17 @@ This library allows for the position, rotation, velocity and rotational velocity
multiple bodies in space, especially in relation to one another. It makes extensive use of NAIF's
SPICE data for such calculations.
## Using ALE to generate ISDs
To generate an ISD for an image, use the load(s) function. Pass the path to your image/label file and ALE will attempt to find a suitable driver and return an ISD. You can use load to generate the ISD as a dictionary or loads to generate the ISD as a JSON encoded string.
```
isd_dict = load(path_to_label)
isd_string = loads(path_to_label)
```
You can get more verbose output from load(s) by passing verbose=True. If you are having difficulty generating an ISD enable the verbose flag to view the actual errors encountered in drivers.
## Setting up dependencies with conda (RECOMMENDED)
Install conda (either [Anaconda](https://www.anaconda.com/download/#linux) or
...
...
@@ -16,8 +27,7 @@ Install conda (either [Anaconda](https://www.anaconda.com/download/#linux) or
instructions may be found [here](https://conda.io/docs/user-guide/install/index.html).
### Creating an isolated conda environment
(TODO This command will need to be updated)
Run the following commands to create a self-contained dev environment for ale (type `y` to confirm creation):
Run the following commands to create a self-contained dev environment for ALE (type `y` to confirm creation):