Repository: climate Updated Branches: refs/heads/master 353bd505c -> 3a80408bc
Convert Readme to rst Project: http://git-wip-us.apache.org/repos/asf/climate/repo Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/85fd789f Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/85fd789f Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/85fd789f Branch: refs/heads/master Commit: 85fd789f5eb994a510f073e34bbcd505d43fa50c Parents: 353bd50 Author: Prateek Chanda <prateekko...@gmail.com> Authored: Mon Jun 18 17:23:20 2018 +0530 Committer: GitHub <nore...@github.com> Committed: Mon Jun 18 17:23:20 2018 +0530 ---------------------------------------------------------------------- README.md | 36 ------------------------------------ README.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 36 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/climate/blob/85fd789f/README.md ---------------------------------------------------------------------- diff --git a/README.md b/README.md deleted file mode 100644 index 7ffe144..0000000 --- a/README.md +++ /dev/null @@ -1,36 +0,0 @@ -## Apache Open Climate Workbench -[](https://travis-ci.org/apache/climate) -[](https://coveralls.io/github/apache/climate?branch=master) -[](https://requires.io/github/apache/climate/requirements/?branch=master) -[](https://landscape.io/github/apache/climate/master) -[](https://pypi.python.org/pypi/ocw) -[](https://www.python.org/downloads/) -[](https://anaconda.org/conda-forge/ocw) -[](https://anaconda.org/conda-forge/ocw) -[](https://anaconda.org/conda-forge/ocw) - -<img src="./docs/source/ocw-logo-variant-sm-01-01-new.png" width="200" /> - -[Apache Open Climate Workbench](http://climate.apache.org) is an effort to develop software that performs climate model evaluations using model outputs from a variety of different sources (the Earth System Grid Federation, the Coordinated Regional Downscaling Experiment, the U.S. National Climate Assessment and the North American Regional Climate Change Assessment Program) and temporal/spatial scales with remote sensing data from NASA, NOAA and other agencies. The toolkit includes capabilities for rebinning, metrics computation and visualization. For additional project information, please check the [project website](http://climate.apache.org/). - -## Getting Started - -The [project's wiki](https://cwiki.apache.org/confluence/display/CLIMATE/Home) is the best location for help and project information. New users should check out the [Getting Started](https://cwiki.apache.org/confluence/display/CLIMATE/Getting+Started) and [Easy OCW](https://cwiki.apache.org/confluence/display/CLIMATE/Easy-OCW+-+A+Guide+to+Simplifying+OCW+Installation) pages for help getting the necessary dependencies installed. If you would prefer to have an isolated environment set up in a virtual machine you should read the [OCW VM](https://cwiki.apache.org/confluence/display/CLIMATE/OCW+VM+-+A+Self+Contained+OCW+Environment) documentation. It will help you get up and running quickly with a fresh VM image for OCW work. - -There are a number of examples in the *examples* directory to help users get started with the toolkit API. If you have questions, the best way to get help is to email the project mailing lists which can be found on the [project's community page](http://climate.apache.org/community/mailing-lists.html). - -## Development - -OCW always welcomes pull request. Please check the [Developer Area](https://cwiki.apache.org/confluence/display/CLIMATE/Developer+Area) on the wiki for additional information on how to contribute. The [project's JIRA](https://issues.apache.org/jira/browse/CLIMATE) is a great place to start looking for issues to solve. Make sure to stop by the mailing lists and introduce yourself as well! - -## Documentation - -The project host the documentation built from the last release artifact on [the project website](https://climate.apache.org/api/current/index.html) - -If you would like to build the documentation for the project run the following command from the root of the repository: - -``` -cd docs && make html -``` - -You will need to have installed the project dependencies first. Checkout the [Getting Started](https://cwiki.apache.org/confluence/display/CLIMATE/Getting+Started) and [Easy OCW](https://cwiki.apache.org/confluence/display/CLIMATE/Easy-OCW+-+A+Guide+to+Simplifying+OCW+Installation) pages for help getting the necessary dependencies installed. http://git-wip-us.apache.org/repos/asf/climate/blob/85fd789f/README.rst ---------------------------------------------------------------------- diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..d3f23f0 --- /dev/null +++ b/README.rst @@ -0,0 +1,48 @@ +Apache Open Climate Workbench +----------------------------- + +`Build Status`_ `Coverage Status`_ `Requirements Status`_ `Code Health`_ +`PyPI`_ `Python Badge`_ `Anaconda-Server Badge`_ `Anaconda-Server +Downloads Badge`_ `Anaconda-Server Version Badge`_ + +`Apache Open Climate Workbench`_ is an effort to develop software that +performs climate model evaluations using model outputs from a variety of +different sources (the Earth System Grid Federation, the Coordinated +Regional Downscaling Experiment, the U.S. National Climate Assessment +and the North American Regional Climate Change Assessment Program) and +temporal/spatial scales with remote sensing data from NASA, NOAA and +other agencies. The toolkit includes capabilities for rebinning, metrics +computation and visualization. For additional project information, +please check the `project website`_. + +Getting Started +--------------- + +The `projectâs wiki`_ is the best location for help and project +information. New users should check out the `Getting Started`_ and `Easy +OCW`_ pages for help getting the necessary dependencies installed. If +you would prefer to have an isolated environment set up in a virtual +machine you should read the `OCW VM`_ documentation. It will help you +get up and running quickly with a fresh VM image for OCW work. + +There are a number of examples in the *examples* directory to help users +get started with the toolkit API. If you have questions, the best way to +get help is to email the project mailing lists which can be found on the +[projectâs community +page](http://climate.apache.org/community/mailing-li + +.. _Build Status: https://travis-ci.org/apache/climate +.. _Coverage Status: https://coveralls.io/github/apache/climate?branch=master +.. _Requirements Status: https://requires.io/github/apache/climate/requirements/?branch=master +.. _Code Health: https://landscape.io/github/apache/climate/master +.. _PyPI: https://pypi.python.org/pypi/ocw +.. _Python Badge: https://www.python.org/downloads/ +.. _Anaconda-Server Badge: https://anaconda.org/conda-forge/ocw +.. _Anaconda-Server Downloads Badge: https://anaconda.org/conda-forge/ocw +.. _Anaconda-Server Version Badge: https://anaconda.org/conda-forge/ocw +.. _Apache Open Climate Workbench: http://climate.apache.org +.. _project website: http://climate.apache.org/ +.. _projectâs wiki: https://cwiki.apache.org/confluence/display/CLIMATE/Home +.. _Getting Started: https://cwiki.apache.org/confluence/display/CLIMATE/Getting+Started +.. _Easy OCW: https://cwiki.apache.org/confluence/display/CLIMATE/Easy-OCW+-+A+Guide+to+Simplifying+OCW+Installation +.. _OCW VM: https://cwiki.apache.org/confluence/display/CLIMATE/OCW+VM+-+A+Self+Contained+OCW+Environment
