Skip to content

Commit 9c28915

Browse files
authored
Merge pull request #119 from ocefpaf/new_badge
new badge
2 parents 1cdf2e2 + dd72ecc commit 9c28915

File tree

1 file changed

+44
-9
lines changed

1 file changed

+44
-9
lines changed

README.md

Lines changed: 44 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,48 +2,78 @@ ODM2 Python API
22
===============
33

44
[![Build Status](https://travis-ci.org/ODM2/ODM2PythonAPI.svg?branch=master)](https://travis-ci.org/ODM2/ODM2PythonAPI)
5-
[![Build status](https://ci.appveyor.com/api/projects/status/47pry4brcrlls6hd/branch/master?svg=true)](https://ci.appveyor.com/project/sreeder/odm2pythonapi/branch/master)
5+
[![Build status](https://ci.appveyor.com/api/projects/status/c13bxn6xvgv5kglt?svg=true)](https://ci.appveyor.com/project/odm2bot/odm2pythonapi)
66

77

8-
A Python-based application programmer's interface for the [Observations Data Model 2 (ODM2)](http://odm2.org).
8+
A Python-based application programmer's interface for the
9+
[Observations Data Model 2 (ODM2)](http://odm2.org).
910

1011
[List of current and planned functions included in the API](https://github.com/ODM2/ODM2PythonAPI/blob/master/doc/APIFunctionList.md)
1112

1213
## Installation
1314

14-
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.
15+
The easiest and most reliable way to install the ODM2 Python API (`odm2api`) is using the
16+
[Conda package management system](http://conda.pydata.org/docs/)
17+
via either
18+
[Anaconda](https://www.continuum.io/downloads)
19+
or
20+
[Miniconda](http://conda.pydata.org/miniconda.html).
21+
To start using conda (if it's not your system default),
22+
add conda to the PATH; on MacOSX and Linux,
23+
it's something like `export PATH=$HOME/miniconda/bin:$PATH`,
24+
but the exact path may vary.
1525

1626
To activate a conda environment, say, "myenv":
27+
1728
```bash
1829
activate myenv # On Windows
1930
source activate myenv # On MacOSX or Linux
2031
```
2132

22-
**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.
33+
**Note:** `odm2api` currently is only tested on Python 2.7. Some changes have been made to support Python 3.x,
34+
but they haven't been tested thoroughly.
2335

2436

2537
### Latest release, from ODM2 anaconda.org channel
2638

27-
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:
39+
The
40+
[latest `odm2api` release](https://github.com/ODM2/ODM2PythonAPI/releases)
41+
is available on the
42+
[ODM2 anaconda.org channel](https://anaconda.org/odm2/odm2api)
43+
for all major OS paltforms (linux, OSX, win32/win64).
44+
To install it on an existing conda environment:
45+
2846
```
2947
conda install -c odm2 odm2api
3048
```
31-
All dependencies are installed, including Pandas and its dependencies (numpy, etc).
49+
50+
All dependencies are installed,
51+
including Pandas and its dependencies (numpy, etc).
3252

3353
To create a new environment "myenv" with the `odm2api` package:
54+
3455
```
3556
conda create -n myenv -c odm2 python=2.7 odm2api
3657
```
3758

3859
### Installing the development version from the `master` branch on github
3960

40-
**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.
61+
**Note from 4/26/2016:** These instructions may be slightly outdated.
62+
Follow these directions for installing the bleeding edge GitHub master branch,
63+
mainly for development and testing purposes.
64+
65+
To create a new environment "myenv" with `odm2api`,
66+
first download the conda environment file
67+
[condaenvironment_1.yml](https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/condaenvironment_1.yml).
68+
Go to the directory where `condaenvironment_1.yml` was downloaded.
69+
Then, on a terminal shell:
4170

42-
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:
4371
```bash
4472
conda env create -n myenv --file py2_conda_environment.yml
4573
```
74+
4675
Activate the new environment, then install `odm2api` into the environment:
76+
4777
```bash
4878
activate myenv # On Windows
4979
source activate myenv # On MacOSX or Linux
@@ -53,4 +83,9 @@ pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI
5383

5484
## Credits
5585

56-
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.
86+
This work was supported by National Science Foundation Grants
87+
[EAR-1224638](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1224638)
88+
and
89+
[ACI-1339834](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1339834).
90+
Any opinions, findings,
91+
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.

0 commit comments

Comments
 (0)