Skip to content

Latest commit

 

History

History
89 lines (57 loc) · 3.21 KB

README.md

File metadata and controls

89 lines (57 loc) · 3.21 KB

PLIO

Planetary Input / Output Join the chat at https://gitter.im/USGS-Astrogeology/plio

A planetary surface data input/output library written in Python. The documentation is at:

https://plio.readthedocs.io/en/latest/

The release version of plio is avaiable via conda-forge.

Current build status

Linux OSX Windows

Documentation Status

Current release info

Name Downloads Version Platforms
Conda Recipe Conda Downloads Conda Version Conda Platforms

Installing plio

Installing plio from the conda-forge channel can be achieved by adding conda-forge to your channels with:

conda config --add channels conda-forge

Once the conda-forge channel has been enabled, plio can be installed with:

conda install plio

It is possible to list all of the versions of plio available on your platform with:

conda search plio --channel conda-forge

Installing development branch of plio

We maintain a development branch of plio that is used as a staging area for our releases. The badges and information below describe the bleeding edge builds.

Build Status

Coverage Status

To install the development version:

conda install -c usgs-astrogeology/label/dev plio

Building documentation

Create the plio conda environment:

conda env create -f environment.yml

Activate the conda environment:

conda activate plio

Go into the docs directory and build the sphinx docs with:

sphinx-build -b html . public

This outputs the generated documentation into docs/public where you can open public/index.html in a browser to view PLIO docs locally.