odm2api 0.5.2

ODM2 Python API
====

为[观测数据模型2 (ODM2)](http://odm2.org)提供的Python应用程序编程接口。

API中包含的当前和计划中的功能列表[链接](https://github.com/ODM2/ODM2PythonAPI/blob/master/doc/APIFunctionList.md)

## 安装

安装ODM2 Python API（`odm2api`）最简单、最可靠的方法是使用[Conda软件包管理器](http://conda.pydata.org/docs/)，无论是通过[Anaconda](https://www.continuum.io/downloads)还是[Miniconda](http://conda.pydata.org/miniconda.html)。若要开始使用conda（如果它不是您的系统默认设置），请将conda添加到PATH；在MacOSX和Linux上，这类似于`export PATH=$HOME/miniconda/bin:$PATH`，但具体路径可能有所不同。

激活conda环境，例如，“myenv”
```bash
activate myenv # Windows上
source activate myenv # MacOSX或Linux上
```

**注意**：`odm2api`目前仅在Python 2.7上进行了测试。为了支持Python 3.x，已进行了某些更改，但这些更改尚未经过彻底测试。


### 来自ODM2 anaconda.org频道的最新版本

最新的`odm2api`版本（[odm2api版本](https://github.com/ODM2/ODM2PythonAPI/releases)）可在[ODM2 anaconda.org频道](https://anaconda.org/odm2/odm2api)上获取，适用于所有主要操作系统平台（linux、OSX、win32/win64）。要在现有conda环境中安装它
```
conda install -c odm2 odm2api
```
所有依赖项都已安装，包括Pandas及其依赖项（numpy等）。

要创建包含`odm2api`包的新环境“myenv”
```
conda create -n myenv -c odm2 python=2.7 odm2api
```

### 从GitHub的`master`分支安装开发版本

**2016年4月26日的说明**：这些说明可能略有过时。以下说明用于安装github master分支的最新版本，主要用于开发和测试目的。

要创建包含`odm2api`的新环境“myenv”，首先下载conda环境文件[condaenvironment_1.yml](https://raw.githubusercontent.com/ODM2/ODM2PythonAPI/master/condaenvironment_1.yml)。转到`condaenvironment_1.yml`下载的目录。然后，在终端shell中
```bash
conda env create -n myenv --file py2_conda_environment.yml
```
激活新环境，然后在该环境中安装`odm2api`
```bash
activate myenv # Windows上
source activate myenv # MacOSX或Linux上

pip install --process-dependency-links git+https://github.com/ODM2/ODM2PythonAPI.git
```

## 致谢

本工作得到了国家科学基金会资助的[EAR-1224638](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1224638)和[ACI-1339834](http://www.nsf.gov/awardsearch/showAward?AWD_ID=1339834)项目支持。本文档中表达的观点、发现、结论或建议均为作者的观点，不一定反映国家科学基金会的观点。