From e6e33e67535528c25e54f791e5638d155e17043a Mon Sep 17 00:00:00 2001 From: Philippe Roy Date: Tue, 20 Dec 2016 10:08:22 -0500 Subject: [PATCH] updated README.md --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 2237befa..1507b86f 100644 --- a/README.md +++ b/README.md @@ -9,10 +9,16 @@ This package is a collection of commonly-used tools in Climate Science. This is This package is now registered on METADATA.jl and can be added with `Pkg.add("ClimateTools")` and used with `using ClimateTools`. +The climate indices are coded to use multiple threads. To gain maximum performance, use (bash shell) `export JULIA_NUM_THREADS=n`, where _n_ is the number of threads. To get an idea of the number of threads you can use type (in Julia) `Sys.CPU_CORES`. + Since the package is evolving "rapidly", you might prefer to checkout the git repo directly. `git checkout https://github.com/Balinus/ClimateTools.jl.git` +## Documentation + +Minimal documentation can be found [here.](https://balinus.github.io/ClimateTools.jl/ "ClimateTools.jl documentation") + ## Objectives * Visualization of NetCDF files (e.g. temporal mean of a given NetCDF file), for rapid evaluation of NetCDF files