Skip to content

Commit

Permalink
Merge pull request #85 from gaelforget/v0p2p11c
Browse files Browse the repository at this point in the history
V0p2p11c
  • Loading branch information
gaelforget committed Sep 3, 2022
2 parents 3cf15cd + 68aa8b7 commit 8bf6ea2
Show file tree
Hide file tree
Showing 6 changed files with 128 additions and 126 deletions.
2 changes: 1 addition & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ClimateModels"
uuid = "f6adb021-9183-4f40-84dc-8cea6f651bb0"
authors = ["gaelforget <gforget@mit.edu>"]
version = "0.2.10"
version = "0.2.11"

[deps]
CFTime = "179af706-886a-5703-950a-314cd64e0468"
Expand Down
2 changes: 2 additions & 0 deletions docs/src/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,8 @@ Here are convenience functions to use [Pluto.jl](https://github.com/fonsp/Pluto.
```@docs
setup(::ModelConfig,::String)
notebooks.unroll
notebooks.list
notebooks.download
notebooks.open
```

Expand Down
4 changes: 3 additions & 1 deletion docs/src/functionalities.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,9 @@ The `ClimateModels.jl` interface can easily be customized to turn these paramete

## Tracked Worklow Support

The [`setup`](@ref) method normally calls [`log`](@ref) to create a temporary run folder with a `git` enabled subfolder called `log`. This allows for recording each workflow step via the [`log`](@ref) methods.
When creating a `ModelConfig`, it receives a unique identifier (`UUIDs.uuid4()`). By default, this identifier is used in the name of the run folder attached to the `ModelConfig`.

The run folder normally gets created by [`setup`](@ref), which itself calls [`log`](@ref) to create a `git` enabled subfolder called `log`. This allows for recording each workflow step via the [`log`](@ref) methods.

As shown in the [Parameters](@ref) example:

Expand Down
Loading

0 comments on commit 8bf6ea2

Please sign in to comment.