iamdonovan / spymicmac

A python package for processing KH-9 and historical aerial imagery using MicMac
GNU General Public License v3.0
12 stars 4 forks source link
micmac python

Documentation Status PyPI version Conda Version Conda Platforms Anaconda-Server Badge

sPyMicMac

A python package to help in the processing of KH-9 and historical aerial imagery using MicMac.

Installing MicMac

General instructions for installing MicMac can be found via the Installation tutorial found on the MicMac wiki. For specific instructions for installing the version of MicMac used in developing sPyMicMac, check out the readthedocs page for sPyMicMac.

Installing sPyMicMac from PyPI

As of version 0.1, sPyMicMac is available via PyPI. To install the latest packaged version (0.1.1), simply run:

pip install spymicmac

to install sPyMicMac in your environment.

Installing sPyMicMac from conda-forge

As of version 0.1.1, sPyMicMac is available via conda-forge. To install the latest packaged version (0.1.1), simply run:

conda install -c conda-forge spymicmac

to install spymicmac in your environment.

Installing the latest version of sPyMicMac

To install the latest version of sPyMicMac, first clone the GitHub repository:

git clone git@github.com:iamdonovan/sPyMicMac.git

Environment setup

Using conda and the environment.yml file from this repository:

cd path/to/repository
conda env create -f environment.yml

Once the environment has been created successfully (this can take some time, so grab a coffee), activate it:

conda activate spymicmac

To install this version of sPyMicMac as a static package, run pip without the -e flag:

# install the development version
pip install .

To install a development version of sPyMicMac, you can use the -e flag:

# install the development version in editing mode
pip install -e .

Basic usage

For more detailed information on using sPyMicMac, see the readthedocs page.

import spymicmac.register as rt