Skip to content

Commit f5d2827

Browse files
committedOct 23, 2023
Updated README.md
1 parent 3c0509e commit f5d2827

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed
 

‎README.md

+14-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,20 @@
22

33
# VIRTUAL LAB
44

5-
Virtual Lab is a simulation manager software which has the purpose of simplifying the pipeline involved in testing scientific computational models. The main idea behind virtual lab is to organize the workflow into separate steps in order to keep the user scripts as clean as possible:
5+
Virtual Lab is a simulation manager software which has the purpose of simplifying the pipeline involved in testing scientific computational models.
6+
7+
## Installation
8+
9+
At the moment a distribution is yet to be uploaded to PyPI, so in order to install the package you will have to clone the repo and run the following command (from the local folder where you saved your cloned repo):
10+
```
11+
pip install virtual_lab // or python -m pip install virtual_lab
12+
```
13+
This will already take care of the required dependencies and `virtual_lab` should work immediately.
14+
15+
16+
17+
## Description
18+
The main idea behind virtual lab is to organize the workflow into separate steps in order to keep the user scripts as clean as possible:
619
1. First, defining our `Model`, which can contain any number of time dependent functions, differential equations or any of the currently supported stochastic processes. The default values of the parameters used in the model can be given at initialization and will then be available as class attributes.
720
2. Then defining some `Experiment`s, which describe the experimental conditions under which we want to analyse our model during our simulations. Each experiment defines a set of events which will correspond to time dependent modifications to the parameters of our model.
821
3. Finally, we initialize our `Simulation`, which can apply the `Experiment`'s conditions to our `Model`, run simulations and analyse the results. Our `Simulation` can contain any number of `Model`s and can readily compare the results obtained on the same `Experiment` from different models.

0 commit comments

Comments
 (0)
Please sign in to comment.