Git Product home page Git Product logo

ale's Introduction

ALE

Abstraction Layer for Ephemerides (ALE)

Build Status Coverage Status Docs

This library allows for the position, rotation, velocity and rotational velocity tracking of 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 or Miniconda) if you do not already have it. Installation instructions may be found here.

Creating an isolated conda environment

Run the following commands to create a self-contained dev environment for ALE (type y to confirm creation):

conda env create -n ale -f environment.yml

For more information: conda environments

Activating the environment

After creating the ale environment, we need to activate it. The activation command depends on your shell.

  • tcsh: conda activate ale

You can add these to the end of your $HOME/.bashrc or $HOME/.cshrc if you want the ale environment to be active in every new terminal.

Building ALE

After you've set up and activated your conda environment, you may then build ALE. Inside of a cloned fork of the repository, follow these steps:

python setup.py install
cd build
cmake ..
make

Keep in mind that you will need to clone the repository with the --recursive flag in order to retrieve the gtest submodule for testing. If you have already cloned without the --recursive flag, running the following command will retrieve the gtest submodule manually:

git submodule update --init --recursive

Adding ALE as a dependency

You can add ALE as a dependency of your CMake based C++ project by linking the exported CMake target, ale::ale.

For example:

add_library(my_library some_source.cpp)
find_package(ale REQUIRED)
target_link_libraries(my_library ale::ale)

Running Tests

To test the c++ part of ALE, run:

ctest

from the build directory.

To test the python part of ALE, run:

pytest tests/pytests

ale's People

Contributors

acpaquette avatar amystamile-usgs avatar austinsanders avatar jessemapel avatar jlaura avatar kaitlyndlee avatar kberryusgs avatar ladoramkershner avatar oleg-alexandrov avatar paarongiroux avatar rbeyer avatar scsides avatar sgstapleton avatar thareusgs avatar tthatcher95 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.