Merge branch 'main' into develop

CosmologicalEmulators · Sep 20, 2023 · da47ec9 · da47ec9
2 parents a331727 + b0064a4
commit da47ec9
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,8 @@
 name = "Capse"
 uuid = "994f66c3-d2c7-4ba6-88fb-4a10f50800ba"
 authors = ["marcobonici <[email protected]>"]
-version = "0.2.2"
+
+version = "0.2.1"
 
 [deps]
 AbstractCosmologicalEmulators = "c83c1981-e5c4-4837-9eb8-c9b1572acfc6"

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -52,6 +52,11 @@ trained_emu = Capse.init_emulator(NN_dict, weights, Capse.SimpleChainsEmulator);
 
 `SimpleChains.jl` is faster expecially for small NN on the CPU. If you prefer to use `Lux.jl`, pass as last argument `Capse.LuxEmulator`.
 
+Each trained emulator should be shipped with a description within the JSON file. In order to print the description, just runs:
+
+```@example tutorial
+Capse.get_emulator_description(NN_dict["emulator_description"])
+```
 After instantiating the NN, we need:
 
 - the ``\ell``-grid used to train the emulator, `ℓgrid`