diff --git a/.gitignore b/.gitignore index ac6354c..9af2266 100644 --- a/.gitignore +++ b/.gitignore @@ -24,10 +24,16 @@ deps/src/ docs/build/ docs/site/ # Literate.jl creates chunk files. -docs/src/literate +docs/src/commonrandom.md +docs/src/constant_birth.md docs/src/distributions.md +docs/src/gsmp.md +docs/src/hierarchical.md +docs/src/literate docs/src/mainloop.md -docs/src/constant_birth.md +docs/src/memory.md +docs/src/reliability.md +docs/src/shifting.md docs/src/sir.md # File generated by Pkg, the package manager, based on a corresponding Project.toml diff --git a/docs/make.jl b/docs/make.jl index 1751ae0..524b364 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -20,7 +20,10 @@ adliterate = [ ("constant_birth.jl", "constant_birth"), ("sir.jl", "sir"), ("commonrandom.jl", "commonrandom"), - ("reliability.jl", "reliability") + ("reliability.jl", "reliability"), + ("memory.jl", "memory"), + ("gsmp.jl", "gsmp"), + ("hierarchical.jl", "hierarchical") ] literate_subdir = joinpath(example_base, "literate") isdir(literate_subdir) || mkdir(literate_subdir) @@ -37,7 +40,7 @@ for (source, target) in adliterate rm("$(ftarget).md", force=true) end if !isfile("$(ftarget).md") || mtime(fsource) > mtime("$(ftarget).md") - println("Literate of $source to $target") + @info "Literate of $source to $target" Literate.markdown( fsource, example_base, @@ -48,7 +51,10 @@ for (source, target) in adliterate ischunk = Regex("$(target)-[0-9]+.(png|svg|pdf)") chunks = [fn for fn in readdir(example_base) if match(ischunk, fn) !== nothing] for chunk in chunks - mv(joinpath(example_base, chunk), joinpath(example_base, "literate", chunk)) + chunk_source = joinpath(example_base, chunk) + chunk_target = joinpath(example_base, "literate", chunk) + @info "Moving $chunk_source to $chunk_target" + mv(chunk_source, chunk_target) end end end @@ -72,13 +78,13 @@ makedocs(; "distributions.md" ], "Manual" => [ - "Structure" => "objects.md", - "commonrandom.md", - "background.md", "distrib.md", - "Develop" => "develop.md", + "background.md", + "GSMP" => "gsmp.md", "samplers.md", - "Vector Addition Systems" => "vas.md", + "hierarchical.md", + "memory.md", + "commonrandom.md", ], "Examples" => [ "Birth-death Process" => "constant_birth.md", diff --git a/docs/src/assets/FleckTopLevel.svg b/docs/src/assets/FleckTopLevel.svg new file mode 100644 index 0000000..cabdd59 --- /dev/null +++ b/docs/src/assets/FleckTopLevel.svg @@ -0,0 +1,105 @@ + + + + + + + + + + + + + + + + + + + + + + Canvas 1 + + + Layer 1 + + + + + Fleck decides + which transition + happens next. + + + + + + + Simulation STATE + + + + + + + Which transitions + could + happen next + + + + + + + Handle the next + transition + + + + + + + + + + + + + + + + + + + + + Logic + + + + + + + Data + structure + + + + + Legend + + + + + + + + + Enable + Disable + + + + + diff --git a/docs/src/background.md b/docs/src/background.md index b7c6d8c..75f164f 100644 --- a/docs/src/background.md +++ b/docs/src/background.md @@ -1,4 +1,4 @@ -# Background +# Markov Processes This addresses two main points, how to specify a model for the library using distributions defined by hazards and why such a specification, @@ -18,8 +18,8 @@ measles. It frequently happens that random samples of the real valued variables such as $\bf{X}$ are actually analyzed on a discrete scale. For example Stocks' data on latent periods of measles in -`latent_period`{.interpreted-text role="ref"} is based on daily visits -by patients. +`latent_period` is based on daily visits +by patients [Stocks:1931]. The (cumulative) distribution of $\bf{X}$ is defined as @@ -36,7 +36,7 @@ f_{X}(k) & = \mathcal{P}[X=k] \\ \end{aligned} ``` -For Stocks' data in `latent_period`{.interpreted-text role="ref"}, the +For Stocks' data in `latent_period`, the density at day $k$ should be interpreted as the probability of the appearance of symptoms since the previous visit on day $k-1$. @@ -53,7 +53,7 @@ h_{X}(k) & = \mathcal{P}[X=k\; |\; k-1