Skip to content

Latest commit

 

History

History
80 lines (62 loc) · 5.25 KB

Apache_OCW_IbrahimJarif.md

File metadata and controls

80 lines (62 loc) · 5.25 KB
Raw

How to contribute to Apache Open Climate Workbench

What is Apache Open Climate Workbench (OCW)

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 Climate 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.

Getting Involved

You don't need to be a software developer to contribute to Apache Open Climate Workbench! To be successful the community requires (and appreciates) a range of different skills, levels of involvement and degrees of technical competency.

So, if you want to get involved in Apache Open Climate Workbench, there is almost certainly a role for you. We are looking for people to:

  • Provide feedback
  • Write or update documentation
  • Help new users
  • Recommend the project to others
  • Test the code and report bugs
  • Fix bugs and submit patches
  • Give us feedback on required features
  • Write and update the software
  • Create artwork
  • Translate to different languages
  • Anything you can see that needs doing

All of these contributions help to keep a project active and strengthen the community. The project team and the broader community will therefore welcome and encourage participation, and attempt to make it as easy as possible for people to get involved

Setting up development environment

Grab the latest code from the ASF (User)

git clone http://git-wip-us.apache.org/repos/asf/climate.git

Dependency Installation

Using conda

This is the simplest and recommended installation method. You will first need to install the conda package manager, which can be readily obtained through either the Anaconda or Miniconda scientific python distributions. Be sure to allow the installation to update your PATH for you.

Before invoking conda to install the dependencies, it's always a good idea to ensure that your version of conda is up to date. You can do this with:

# Update conda packages
$ conda update conda
# Add the conda-forge repository to your package manager
$ conda config --add channels conda-forge
# Install ocw to ~/anaconda or ~/miniconda2/3
$ conda install ocw

This installation method should work for all major platforms, making it particularly advantageous.

Test Your Installation

The easiest way to test your installation is to run one of the example scripts in $HOME/climate/examples.

$ cd $HOME/climate/examples
$ python simple_model_to_model_bias.py

If you face run-time exceptions with the above, make sure you have the libpng16 library installed, and are not running libpng12.

If everything runs successfully you should see a plot similar to the one below in the examples folder.

Installing the OCW UI

If you would like to install and use the OCW-UI for running simple evaluations through your web browser, check the Open Climate Workbench User Interface Installation and Overview guide to get started.

Using the OCW VM

If you want to get up and running with OCW quickly and with minimal overhead consider using the OCW VM. You can read about how to build the VM on the OCW VM - A Self Contained OCW Environment page. The OCW VM gives you an isolated VM environment with OCW pre-setup for you so you can get up and running without installing dependencies or configuring your system.

Mailing lists

This is where the community hangs out and discussion about development happens. This list is used to coordinate activities and ensure we are all pulling in the same direction.

Useful Links