version + dwl instructions

dmetivie · Jan 15, 2025 · a8d01a2 · a8d01a2
1 parent 9358400
commit a8d01a2
Show file tree

Hide file tree

Showing 5 changed files with 17 additions and 1,399 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "StochasticWeatherGenerators"
 uuid = "3eadb0b9-5057-49d2-9b8f-52a8c334ebf6"
 authors = ["David Métivier <[email protected]>"]
-version = "1.2.0-DEV"
+version = "1.2.1-DEV"
 
 [deps]
 CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"

diff --git a/README.md b/README.md
@@ -7,6 +7,21 @@
 
 A Julia package, to define, fit and use Stochastic Weather Generators (SWG).
 
+The package is currently NOT in the Julia general registry (will be soon), but on a local registry, hence to download it just add:
+
+```julia
+using Pkg
+pkg"registry add https://github.com/dmetivie/LocalRegistry"
+```
+
+and then `add` it as a normal package
+
+```julia
+Pkg.add("StochasticWeatherGenerators")
+# or
+pkg> add StochasticWeatherGenerators
+```
+
 Currently, the package offers:
 
 - The daily multisite rain SWG proposed in the [*Interpretable Seasonal Hidden Markov Model for spatio-temporal stochastic rain generation in France*](https://hal.inrae.fr/hal-04621349) paper. This SWG relies on a "Seasonal Autoregressive Hidden Markov Models" (SHMM) with interpretable hidden states. Note that the seasonal models HMM, AR etc are currently implemented in a separate package [SmoothPeriodicStatsModels.jl](https://github.com/dmetivie/SmoothPeriodicStatsModels.jl).