Merge pull request #92 from gaelforget/v0p2p14b

V0p2p14b

Project.toml

@@ -1,7 +1,7 @@
 name = "ClimateModels"
 uuid = "f6adb021-9183-4f40-84dc-8cea6f651bb0"
 authors = ["gaelforget <gforget@mit.edu>"]
-version = "0.2.13"
+version = "0.2.14"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

docs/src/examples.md

@@ -2,6 +2,10 @@
 
 A good place to start is the [random walk model](RandomWalker.html) example. It is also presented in greater detail in the [Climate Model Interface](@ref) section to further illustrate how things work.
 
+```@docs
+RandomWalker
+```
+
 The examples generally fall into two categories : 
 
 - [Workflows That Run Models](@ref run_model_examples)

docs/src/functionalities.md

@@ -30,7 +30,7 @@ or using the [`@ModelRun`](@ref) to abbreviate further:
 @ModelRun ClimateModels.RandomWalker
 ```
 
-The above example uses `ClimateModels.RandomWalker` as the model's top level function / wrapper function. 
+The above example uses [RandomWalker](@ref) as the model's top level function / wrapper function. 
 
 By design of our interface, **it is required** that this function receives a `ModelConfig` as its sole input argument. 
 
@@ -44,8 +44,6 @@ MC=ModelConfig(model=ClimateModels.RandomWalker)
 nothing #hide
 ```
 
-The `model`'s top level function gets called via [`launch`](@ref). In our example, `f` thus generates a file called `RandomWalker.csv`, which gets stored in the run folder. 
-
 The sequence of calls within `ModelRun` can then be expanded as shown below. In practice, `setup` typically handles files and software, `build` may compile a chosen model configuration, and `launch` takes care of the main computation. 
 
 ```@example main
@@ -54,6 +52,8 @@ build(MC)
 launch(MC)
 ```
 
+The `model`'s top level function gets called via [`launch`](@ref). In our example, it generates a CSV file found in the run folder as shown below. 
+
 !!! note
     It is **not required** that compilation takes place during `build`. It can also be done beforehand or within `launch`.
 

src/ClimateModels.jl

@@ -11,6 +11,7 @@ export put!, take!, pathof, readdir, log
 #export git_log_prm, git_log_show
 #export monitor, help, pause
 #export train, compare, analyze
+export RandomWalker
 
 export OrderedDict, UUID, uuid4, @suppress #should be commented out?
 

src/toy_models.jl

@@ -4,9 +4,11 @@ using CSV, DataFrames
 """
 RandomWalker(x::AbstractModelConfig)
 
-Random Walk in 2D over `NS` steps (100 by default). Returns the results to as an array and 
-saves them to a `.csv` file (_RandomWalker.csv_ by default) inside the run directory 
-(`pathof(x)` by default), if `setup` method has been invoked to create it.
+Random Walk in 2D over `NS` steps (100 by default). The results are returned as an array 
+and saved to a text file (`RandomWalker.csv`` by default) inside the `run` folder 
+(`pathof(x)` by default). 
+
+Note: the `setup` method should be invoked to create the `run` folder beforehand.
 """
 function RandomWalker(x::AbstractModelConfig)
  #model run