https://github.com/doi-usgs/plio

Planetary I/O Module
https://github.com/doi-usgs/plio

chem-cam isis3-control-networks krc moon-minerology-mapper spectral-profiler tes

Last synced: 5 months ago
JSON representation

Planetary I/O Module

• Host: GitHub
• URL: https://github.com/doi-usgs/plio
• Owner: DOI-USGS
• License: other
• Created: 2016-06-08T17:45:25.000Z (almost 9 years ago)
• Default Branch: main
• Last Pushed: 2024-11-13T17:49:16.000Z (6 months ago)
• Last Synced: 2024-12-12T06:08:02.449Z (5 months ago)
• Topics: chem-cam, isis3-control-networks, krc, moon-minerology-mapper, spectral-profiler, tes
• Language: Python
• Homepage:
• Size: 24.3 MB
• Stars: 15
• Watchers: 10
• Forks: 23
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        


   



Planetary Input / Output [![Join the chat at https://gitter.im/USGS-Astrogeology/plio](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/USGS-Astrogeology/plio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

===============================

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](https://img.shields.io/circleci/project/github/conda-forge/plio-feedstock/master.svg?label=Linux)](https://circleci.com/gh/conda-forge/plio-feedstock)

[![OSX](https://img.shields.io/travis/conda-forge/plio-feedstock/master.svg?label=macOS)](https://travis-ci.org/conda-forge/plio-feedstock)

[![Windows](https://img.shields.io/appveyor/ci/conda-forge/plio-feedstock/master.svg?label=Windows)](https://ci.appveyor.com/project/conda-forge/plio-feedstock/branch/master)

[![Documentation Status](https://readthedocs.org/projects/plio/badge/?version=latest)](https://plio.readthedocs.io/en/latest/?badge=latest)

Current release info

====================

| Name | Downloads | Version | Platforms |

| --- | --- | --- | --- |

| [![Conda Recipe](https://img.shields.io/badge/recipe-plio-green.svg)](https://anaconda.org/conda-forge/plio) | [![Conda Downloads](https://img.shields.io/conda/dn/conda-forge/plio.svg)](https://anaconda.org/conda-forge/plio) | [![Conda Version](https://img.shields.io/conda/vn/conda-forge/plio.svg)](https://anaconda.org/conda-forge/plio) | [![Conda Platforms](https://img.shields.io/conda/pn/conda-forge/plio.svg)](https://anaconda.org/conda-forge/plio) |

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](https://travis-ci.org/USGS-Astrogeology/plio.svg?branch=dev)](https://travis-ci.org/USGS-Astrogeology/plio)

[![Coverage Status](https://coveralls.io/repos/github/USGS-Astrogeology/plio/badge.svg?branch=master)](https://coveralls.io/github/USGS-Astrogeology/plio?branch=master)

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.