acerim 0.0.8

Overview

Welcome to ACERIM!

Please note: this package is still in pre-alpha and is actively under development. You can direct any questions to Christian at cj.taiudovicic@gmail.com.

The Automated Crater Ejecta Region of Interest Mapper (ACERIM) is a python package for planetary scientists that simplifies crater data analysis. If you have image data and a list of crater locations, ACERIM will help you extract data from those locations and analyze that data with statistics of your choosing.

Use ACERIM if you want to do one or more of the following:

- import crater databases and image datasets into easily queried python objects;
- extract image data from regions around craters given their latitude, longitude, radius, and the desired ROI window size;
- mask your data arays to isolate pixels within the crater, on the ejecta blanket, or within a user-provided shapefile;
- compute statistics on the extracted crater/ejecta data;
- save and plot your ROIs and statistics.

New users can head to acerim/sample/tutorial.py for a step-by-step walkthrough (with sample data) of how to use ACERIM in a research workflow.

Note: This package was written with the Moon in mind, but is applicable to any cratered planetary body. However, ACERIM currently only supports image data in the simple cylindrical projection. For assistance reprojecting images in python, see GDAL.

Dependencies

ACERIM is compatible with python versions 2.7-3.3. Additionally, the following packages are required for ACERIM to run:

- gdal
- numpy
- scipy
- pandas
- matplotlib

Installation

PLEASE NOTE: Acerim depends on the GDAL (Geospatial Data Abstraction Library) python package. Since GDAL in turn depends on C++, it is highly recommended that you follow the installation instructions for gdal on PyPI here. Once GDAL is successfully isntalled, proceed with installing ACERIM.

conda create --name env_name python=3.3 gdal numpy scipy pandas matplotlib

source activate env_name

pip install acerim

python -c "import acerim"

python setup.py install

Organization

The project has the following structure:

acerim/
  |- README.rst
  |- acerim/
     |- aceclasses.py
     |- acefunctions.py
     |- acestats.py
     |- sample
        |- craters.csv
        |- moon.tif
        |- tutorial.rst
        |- tutorial.py
     |- tests
        |- test_classes.py
        |- test_functions.py
     |- version.py
  |- docs/
  |- setup.py
  |- setup.cfg
  |- LICENSE.txt

The core of this project is located in /acerim. To get started using ACERIM, see tutorial.py in /acerim/sample. API documentation is listed in /docs and is also available at readthedocs. A suite of unittests is located in /acerim/tests.

Testing ACERIM

A suite of unittests are located in the /acerim/tests. They use the sample data included in /acerim/sample to test all ACERIM classes and functions. To test if ACERIM is working as it should on your machine, install the pytest module (using conda install pytest or pip install pytest) and follow the following steps:

1) open a shell/cmd window
2) navigate to the parent ACERIM directory (e.g.'/Users/cjtu/Desktop/acerim')
3) run the following command:

py.test acerim

A summary of test results will appear in the shell.

Support and Bug Reporting

Any bugs or errors can be reported to Christian at cj.taiudovicic@gmail.com. Please include your operating system and details of your python environment (e.g. using conda list).

Citing ACERIM

For convenience, this project uses the OSI-certified MIT open access liscence for ease of use and distribution. The author simply asks that you cite the project if you use it in your work. Citation information can be found and easily exported in your desired format at:

License

Copyright (c) 2017- Christian Tai Udovicic. Released under the MIT license. This software comes with no warranties. See LICENSE.txt for details.