Codes for ANalysis of Asteroids

An open-source python tool for asteroid science

What is CANA?

The CANA package stands for “Codes for ANalysis of Asteroids”. The tool was designed to perform scientific analysis for asteroids spectroscopic data.

As part of the PRIMitive Asteroids Spectroscopic Survey (PRIMASS), we have collected and analyzed hundreds of spectra of primitive asteroids among the last years. In this context, we collected the routines used for the analysis and parametrization of these data to build up a python package design for the asteroid community. As we are preparing to make the data library (PRIMASS-L) public to the community through Small Bodies Node of the the Planetary Data Science (PDS), it is our aim to make our science reproducible and of easy to extended.

Click on the links bellow, if you would like to know more about PRIMASS or PRIMASS-L:

Contents

The package is currently under development. At the moment CANA counts with:

Spectroscopic analysis tools:

• Handling tools, such as load, trim, fit (and autofit), estimate SNR, clean spectrum
• Slope calculation
• Taxonomic Classification
• Hydration band analysis

We will soon make available new parametrization methods and tools for handling Photometric data and Compositional modeling!

Get Started

See the install instructions to set up your computer and install Cana.

Once you have everything installed, we recommend you take a look at our recipes at the Cookbook, to get an idea of what cana can do. For more detailed documentation go to the Documentation page to get the complete API description.

Cana is still a work in progress, if you are have trouble getting it to work, or you want to give us a feedback or colaborate, you can:

• Write to Mário De Prá
• Report bugs, enhancements or else through Github.

Cite

CANA is a open tool. You can use, adapt and modify it as wanted. But if you any of these, please cite us!

De Pra, M., Carvano, J., Morate, D., Licandro, J. Pinilla-Alonso, N. (2018). CANA: An open-source python tool to study hydration in the Solar System.

See cite to get the bibtex entry for the citation.

Installing Cana

Which Python?

As Python 2.7 is coming to an end, we have updated all code for Python >=3.6, and do not provide support for Python 2.

We recommend using the Anaconda Python distribution to ensure you have all dependencies installed.

Installing with pip (recommended)

If you have Anaconda or pip installed:

pip install cana-asteroids

Installing the lastest version

You can get the current development version with:

pip install git+https://github.com/cana-asteroids/cana.git

Dependencies

If you have any problems with the instalation, check if all dependencies are installed. The dependencies can be seen below:

• Numpy
• Pandas
• Scipy
• Matplotlib
• Sklearn

Citing Cana

CANA is made by scientists. Citing us help us justify the effort that goes into building, maintaining and making it an open tool.

De Pra, M., Carvano, J., Morate, D., Licandro, J. Pinilla-Alonso, N. (2018). CANA: An open-source python package to study hydration in the Solar System.

Here is a Bibtex entry for LaTeX users:

@InProceedings{ ,
  author    = { Mario De Pra, Jorge Carvano, David Morate, Javier Licandro and Noemi Pinilla-Alonso },
  title     = { Cana: An open-source python tool to study hydration in the Solar System },
  booktitle = {  },
  pages     = {  },
  year      = { 2018 },
  editor    = { }
}

CANA: Codes for ANalysis of Asteroids

The CANA package arised in the context of the PRIMitive Asteroid Spectrocopic Survey (PRIMASS). As we move to make the first data release of the survey, we provided a package that is made up of a collection of methodologies and codes that were used to analyze the survey data. These methodologies are strongly focused on the spectroscopic analysis of primitive asteroids, with codes that allow calculating the spectral gradient, identifing a hydration band and performing a taxonomic classification. All the methodologies can be applyied or easily extended for other classes of asteroids.

The aim of this package is to make the science made by PRIMASS accessible, reproducible and extendable.

PRIMitive Asteroid Spectroscopic Survey

PRIMASS is an effort lead by Dr. Noemi Pinilla-Alonso (Florida Space Institute - US) and Dr. Julia de Leon (Instituto de Astrofisica de Canarias - Spain) to map and constrain the composition of primitive asteroids along the Solar System.

The study of primitive asteroids is a key component to undertand the origin and nature of volatile and organic material in the early Solar System. These objects are leftovers of the planetary formation and have undergone little methamorphism since they accreted, therefore providing a rich source of information about the organic compounds naturally present during the prebiotic evolution of the asteroids and terrestrial planets, such as the Earth.

In 2010, we started a observational campaign, using several telescopes around the globe, with the goal of studying the surface of primitive asteroids at different locations in the main asteroid belt, by means of visible and near-infrared spectroscopy. To date we have nearly ~600 spectra of primitive asteroids that were published in more than 10 papers in the literature, and there is more to come!

PRIMASS-L

We were funded by NASA Planetary Data Archiving, Restoration, and Tools (PDART) to organize and make the data public at the Small Bodies Node of the Planetary Data Science (PDS-SBN). The SBN-PDS is largely responsible for archiving the data pertaining to small bodies, obtained from ground-based facilities, including ground-based surveys and other mission data.

We are making the first data release available by the end of 2019 with all spectroscopic data that was already published, which contain ~600 spectra of primitive asteroids, from 10 families and two dynamical groups.

PRIMASS Team

• Dr. Noemi Pinilla Alonso - Florida Space Institute, US (PI)
• Dr. Julia de Leon - Instituto de Astrofisica de Canarias, Spain (PI)
• Dr. Vania Lorenzi - Fundacion Galileo Galilei, Spain
• Dr. David Morate - Observatorio Nacional, Brazil
• Dr. Mario De Pra - Florida Space Institute, US (PI of CANA)
• Dr. Javier Licandro - Instituto de Astrofisica de Canarias, Spain
• Dr. Humberto Campins - University of Central Florida, US
• Dr. Jorge Carvano - Observatorio Nacional, Brazil

PRIMASS Papers

Contribute

There are many ways you can contribute:

Feedback

Send us your bug reports, feature requests, spelling corrections, usage examples, etc. We love to hear what the community thinks!

Documentation

We need a lot of help improving our documentation. You can report typos, suggest new sections and improvements, and anything that you think would make the docs better in any way.

Code

There are many improvements and enhancement that can be made. If you want to get involved with the code, you can send a pull request on Github, open an issue or write to us.

API Reference

Spectroscopy

spec	Tools to handle asteroid spectra.
util	Utility functions.

Spectools

spectools.slopetool	Tool for measuring spectral slope.
spectools.taxonomytool	Tool for spectral taxonomic classification.
spectools.specband	Tool for measuring an absorptium band.
spectools.uncertainties	Tools for estimating parameters uncertainty.

Composition

composition.core
composition.constants	Handle Optical Constants.
composition.shkuratov	Shkuratov Model.
composition.mixtures	Mixtures used in the Shkuratov model.
composition.randomsearch

Documentation (version )

Installing

Instructions to setup cana and its dependencies.

Methodologies

For a complete description of the methodologies implemented in the cana package.

Cookbook

Beginner recipes to get started

API Reference

Documentation for all classes and functions in the cana package.

Methodologies

Under construction…

SDOC: Small Database of Optical Constants

SDOC is a database of selected optical constants to be used in compositional modeling of solar system minor bodies, maintained separately from cana. Note that SDOC is not required to run cana.

All data of the optical constants are stored in a single HDF file, for easy sharing and access of the data.

More information about SDOC and its code is accessible at github.com/depra/sdoc.

This database is currently under construction, the contents of the database are incomplete and used for testing purposes only. A version of database with carefully selected optical constants and their metadata will be available soon.

HDF Database Schema

Dependencies

• h5py
• pandas
• numpy

How to install

If you have Anaconda or pip installed:

pip install cana-sdoc

Usage

For a example of how to access the database and search for a optical constant, take a look at sdoc notebooks., or at the cookbook recipes related to compositional modeling.

Cite

A paper with the description of the database and the compositional modeling techniques is in preparation. However, if you use the optical constants inserted in the db, make sure to cite the references from where the optical constants were extracted.