From dd72ecc64de5afe4e15381b8451301ebf0164b10 Mon Sep 17 00:00:00 2001 From: Filipe Fernandes Date: Sat, 28 Oct 2017 10:03:36 -0300 Subject: [PATCH] new badge --- README.md | 53 ++++++++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 44 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 07a2037..3baeb11 100644 --- a/README.md +++ b/README.md @@ -2,48 +2,78 @@ ODM2 Python API =============== [![Build Status](https://travis-ci.org/ODM2/ODM2PythonAPI.svg?branch=master)](https://travis-ci.org/ODM2/ODM2PythonAPI) -[![Build status](https://ci.appveyor.com/api/projects/status/47pry4brcrlls6hd/branch/master?svg=true)](https://ci.appveyor.com/project/sreeder/odm2pythonapi/branch/master) +[![Build status](https://ci.appveyor.com/api/projects/status/c13bxn6xvgv5kglt?svg=true)](https://ci.appveyor.com/project/odm2bot/odm2pythonapi) -A Python-based application programmer's interface for the [Observations Data Model 2 (ODM2)](http://odm2.org). +A Python-based application programmer's interface for the +[Observations Data Model 2 (ODM2)](http://odm2.org). [List of current and planned functions included in the API](https://github.com/ODM2/ODM2PythonAPI/blob/master/doc/APIFunctionList.md) ## Installation -The easiest and most reliable way to install the ODM2 Python API (`odm2api`) is using the [Conda package management system](http://conda.pydata.org/docs/) via either [Anaconda](https://www.continuum.io/downloads) or [Miniconda](http://conda.pydata.org/miniconda.html). To start using conda (if it's not your system default), add conda to the PATH; on MacOSX and Linux, it's something like `export PATH=$HOME/miniconda/bin:$PATH`, but the exact path may vary. +The easiest and most reliable way to install the ODM2 Python API (`odm2api`) is using the +[Conda package management system](http://conda.pydata.org/docs/) +via either +[Anaconda](https://www.continuum.io/downloads) +or +[Miniconda](http://conda.pydata.org/miniconda.html). +To start using conda (if it's not your system default), +add conda to the PATH; on MacOSX and Linux, +it's something like `export PATH=$HOME/miniconda/bin:$PATH`, +but the exact path may vary. To activate a conda environment, say, "myenv": + ```bash activate myenv # On Windows source activate myenv # On MacOSX or Linux ``` -**Note:** `odm2api` currently is only tested on Python 2.7. Some changes have been made to support Python 3.x, but they haven't been tested thoroughly. +**Note:** `odm2api` currently is only tested on Python 2.7. Some changes have been made to support Python 3.x, +but they haven't been tested thoroughly. ### Latest release, from ODM2 anaconda.org channel -The [latest `odm2api` release](https://github.com/ODM2/ODM2PythonAPI/releases) is available on the [ODM2 anaconda.org channel](https://anaconda.org/odm2/odm2api) for all major OS paltforms (linux, OSX, win32/win64). To install it on an existing conda environment: +The +[latest `odm2api` release](https://github.com/ODM2/ODM2PythonAPI/releases) +is available on the +[ODM2 anaconda.org channel](https://anaconda.org/odm2/odm2api) +for all major OS paltforms (linux, OSX, win32/win64). +To install it on an existing conda environment: + ``` conda install -c odm2 odm2api ``` -All dependencies are installed, including Pandas and its dependencies (numpy, etc). + +All dependencies are installed, +including Pandas and its dependencies (numpy, etc). To create a new environment "myenv" with the `odm2api` package: + ``` conda create -n myenv -c odm2 python=2.7 odm2api ``` ### Installing the development version from the `master` branch on github -**Note from 4/26/2016:** These instructions may be slightly outdated. Follow these directions for installing the bleeding edge github master branch, mainly for development and testing purposes. +**Note from 4/26/2016:** These instructions may be slightly outdated. +Follow these directions for installing the bleeding edge GitHub master branch, +mainly for development and testing purposes. + +To create a new environment "myenv" with `odm2api`, +first download the conda environment file +[condaenvironment_1.yml](https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/condaenvironment_1.yml). +Go to the directory where `condaenvironment_1.yml` was downloaded. +Then, on a terminal shell: -To create a new environment "myenv" with `odm2api`, first download the conda environment file [condaenvironment_1.yml](https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/condaenvironment_1.yml). Go to the directory where `condaenvironment_1.yml` was downloaded. Then, on a terminal shell: ```bash conda env create -n myenv --file py2_conda_environment.yml ``` + Activate the new environment, then install `odm2api` into the environment: + ```bash activate myenv # On Windows source activate myenv # On MacOSX or Linux @@ -53,4 +83,9 @@ pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI ## Credits -This work was supported by National Science Foundation Grants [EAR-1224638](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1224638) and [ACI-1339834](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1339834). Any opinions, findings, and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation. +This work was supported by National Science Foundation Grants +[EAR-1224638](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1224638) +and +[ACI-1339834](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1339834). +Any opinions, findings, +and conclusions or recommendations expressed in this material are those of the author(s) and do not necessarily reflect the views of the National Science Foundation.