Skip to content

Commit

Permalink
major docs changes reflecting v0.5.1
Browse files Browse the repository at this point in the history
  • Loading branch information
ivborissov committed May 8, 2024
1 parent 45f4dea commit fbedff3
Show file tree
Hide file tree
Showing 13 changed files with 246 additions and 253 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
[![version](https://juliahub.com/docs/HetaSimulator/version.svg)](https://juliahub.com/ui/Packages/HetaSimulator/IIE0h)
[![GitHub issues](https://img.shields.io/github/issues/hetalang/HetaSimulator.jl.svg)](https://GitHub.com/hetalang/HetaSimulator.jl/issues/)
[![Coverage Status](https://coveralls.io/repos/github/hetalang/HetaSimulator.jl/badge.svg?branch=master)](https://coveralls.io/github/hetalang/HetaSimulator.jl?branch=master)
[![api-docs](https://img.shields.io/website?down_color=yellow&label=api-docs&up_color=green&url=https%3A%2F%2Fhetalang.github.io%2FHetaSimulator.jl%2Fdev%2F)](https://hetalang.github.io/HetaSimulator.jl/dev)
[![Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://hetalang.github.io/HetaSimulator.jl/stable)
[![GitHub license](https://img.shields.io/github/license/hetalang/HetaSimulator.jl.svg)](https://github.com/hetalang/HetaSimulator.jl/blob/master/LICENSE)

# HetaSimulator

**HetaSimulator** is an OpenSource simulation and parameters estimation (fitting) platform for the [Heta modeling language](https://hetalang.github.io/#/).
**HetaSimulator** is an open-source simulation and parameters estimation (fitting) platform for the [Heta modeling language](https://hetalang.github.io/#/).
The main purpose of the package is to establish the linkage between emerging [QSP frameworks](https://en.wikipedia.org/wiki/Quantitative_systems_pharmacology) and fast computational methods (parallel simulations, automatic differentiation, etc.).

The latest documentation can be found here: <https://hetalang.github.io/HetaSimulator.jl/dev/>.
The latest documentation can be found here: <https://hetalang.github.io/HetaSimulator.jl/stable/>.

See the [ROAD MAP](./roadmap.md) for future implementations.

Expand All @@ -20,7 +20,7 @@ Heta language is a domain-specific modeling language (DSL) for dynamic models us

This package provides the simulation engines for the Heta-based models and modeling platforms to be run in Julia. A QSP model can be directly run using the HetaSimulator without additional tools. The ODE system in general form can also be run with HetaSimulator.

Internally HetaSimulator utilizes the facilities of OpenSource projects like [Julia](https://julialang.org/) and [SciML ecosystem](https://sciml.ai/).
Internally HetaSimulator utilizes the facilities of open-source projects like [Julia](https://julialang.org/) and [SciML ecosystem](https://sciml.ai/).

## Installation

Expand Down Expand Up @@ -88,11 +88,11 @@ df = DataFrame(results)
20.611077 11.9927 0.00733069 ode_
```

*To read more about available functions, see the [documentation](https://hetalang.github.io/HetaSimulator.jl/dev/)*
*To read more about available functions, see the [documentation](https://hetalang.github.io/HetaSimulator.jl/stable/)*

## Getting help

- Read the [docs](https://hetalang.github.io/HetaSimulator.jl/dev/)
- Read the [docs](https://hetalang.github.io/HetaSimulator.jl/stable/)
- Use [Gitter Chatroom](https://gitter.im/hetalang/community?utm_source=readme).
- Use [Issue Tracker](https://github.com/hetalang/HetaSimulator.jl/issues)

Expand Down
8 changes: 4 additions & 4 deletions cases/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Simple models and scenarios to check syntax
# Simple models and scenarios to check the syntax

- story_0 : small model from README file
- story_1 : Run with manual creation of objects
- story_2 : Run everything using `Platform`
- story_0 : A small model from the README file
- story_1 : Manual creation of scenarios, etc
- story_2 : Uses `Platform` object
4 changes: 2 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
using Documenter, HetaSimulator

makedocs(
sitename = "HetaSimulator Docs",
sitename = "HetaSimulator.jl",
authors = "Ivan Borisov, Evgeny Metelkin",
modules = [HetaSimulator],
format = Documenter.HTML(
analytics = "UA-149749027-1",
#assets = ["assets/favicon.ico"],
canonical="https://hetalang.github.io/HetaSimulator.jl/dev/"
canonical="https://hetalang.github.io/HetaSimulator.jl/stable/"
),
pages = [
"Home" => "index.md", # readme
Expand Down
2 changes: 1 addition & 1 deletion docs/src/basics/distributed.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ f = fit([scn1, scn2, scn3], [:k1=>0.1,:k2=>0.2,:k3=>0.3], parallel_type=Ensemble

We can run parallel Monte-Carlo (Ensemble) simulations with parameters taken from distributions or from a pre-generated `DataFrame`.
Parallel setup can work both with parameters vectors and `scenarios`.
Let's assume we have loaded a number of `Scenario`s: `scn1, scn2, scn3` and a `DataFrame` `df` with parameters vectors (as rows).
Let's assume we have loaded a number of `Scenario`s: `scn1, scn2, scn3` and a `DataFrame` `df` with parameters vectors (as rows).
```julia
using Distributed
addprocs(2)
Expand Down
Loading

0 comments on commit fbedff3

Please sign in to comment.