diff --git a/README.rst b/README.rst index f1295723efc4091702c703282ad562020cc177a7..07bd4d4b2d6d1d228c10a22935a37f4be6bdddeb 100644 --- a/README.rst +++ b/README.rst @@ -2,6 +2,43 @@ Planetary Input / Output =============================== +A planetary surface data input/output library written in Python. The release version of `plio` is avaiable via conda-forge. + +Current build status +==================== + +[](https://circleci.com/gh/conda-forge/plio-feedstock) +[](https://travis-ci.org/conda-forge/plio-feedstock) +[](https://ci.appveyor.com/project/conda-forge/plio-feedstock/branch/master) + +Current release info +==================== + +| Name | Downloads | Version | Platforms | +| --- | --- | --- | --- | +| [](https://anaconda.org/conda-forge/plio) | [](https://anaconda.org/conda-forge/plio) | [](https://anaconda.org/conda-forge/plio) | [](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 +``` + .. image:: https://badges.gitter.im/USGS-Astrogeology/plio.svg :alt: Join the chat at https://gitter.im/USGS-Astrogeology/plio :target: https://gitter.im/USGS-Astrogeology/plio?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge @@ -11,17 +48,3 @@ Planetary Input / Output .. image:: https://coveralls.io/repos/github/USGS-Astrogeology/plio/badge.svg?branch=master :target: https://coveralls.io/github/USGS-Astrogeology/plio?branch=master - - -A planetary file I/O API - -Installation ------------- -Installation is unfortunately complicated due to the difficulty in installing GDAL. These are the steps that have been successfully tested on Linux and OSX. - -1. Install Anaconda or Miniconda with Python 3.5 -2. Create a new environment to ensure that the installed package is not going to collide with existing packages - - ``conda create --name <somename> python=3`` -3. Ensure that the `conda-forge` channel is added to your conda config. For instructions, see: https://conda.io/docs/user-guide/tasks/manage-channels.html -4. Install ``plio`` with ``conda install -c usgs-astrogeology plio``.