climate-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jo...@apache.org
Subject [1/2] git commit: CLIMATE-412 - Add README
Date Thu, 29 May 2014 20:34:40 GMT
Repository: climate
Updated Branches:
  refs/heads/master 23af1107d -> 360f23717


CLIMATE-412 - Add README


Project: http://git-wip-us.apache.org/repos/asf/climate/repo
Commit: http://git-wip-us.apache.org/repos/asf/climate/commit/40c8dea9
Tree: http://git-wip-us.apache.org/repos/asf/climate/tree/40c8dea9
Diff: http://git-wip-us.apache.org/repos/asf/climate/diff/40c8dea9

Branch: refs/heads/master
Commit: 40c8dea98962e7e96573ff3e166c9abc4a0094f6
Parents: ffff32b
Author: Michael Joyce <joyce@apache.org>
Authored: Wed May 28 10:52:10 2014 -0700
Committer: Michael Joyce <joyce@apache.org>
Committed: Wed May 28 10:52:10 2014 -0700

----------------------------------------------------------------------
 README.md | 13 +++++++++++++
 1 file changed, 13 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/climate/blob/40c8dea9/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..6d506b3
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+## Apache Open Climate Workbench
+
+Apache Open Climate Workbench is an effort to develop software that performs climate model
evaluation 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!


Mime
View raw message