Skip to content

Commit 9716532

Browse files
committed
build configurations and license
1 parent 1ac1411 commit 9716532

File tree

6 files changed

+43
-2
lines changed

6 files changed

+43
-2
lines changed

.github/workflows/ci-pipeline.yml

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: CI pipeline
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
jobs:
9+
build:
10+
runs-on: ubuntu-latest
11+
12+
steps:
13+
- name: Checkout code
14+
uses: actions/checkout@v2
15+
16+
- name: Set up Python
17+
uses: actions/setup-python@v2
18+
with:
19+
python-version: 3.9
20+
21+
- name: Install dependencies
22+
run: pip install .
23+
- name: Run tests
24+
run: pytest

README.md

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

33
# VIRTUAL LAB
44

5-
Virtual Lab is a simulation manager software which was conceived while working on my Master's thesis and which has the purpose of simplifying the pipeline involved in testing computational models. The main idea behind virtual lab is to organize the workflow into separate steps in order to keep the script 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. 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:
66
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.
77
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.
88
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.

logo/LICENSE-logo.txt

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
The VIRTUAL LAB logo was designed by Memed Kadrija and is licensed licensed under a Creative Commons Attribution 4.0 International License.
2+
To view a copy of this license, visit https://creativecommons.org/licenses/by/4.0/.

logo/acknowledgements.txt

-1
This file was deleted.

pyproject.toml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
[build-system]
2+
requires = [
3+
"setuptools >= 40.9.0",
4+
]
5+
build-backend = "setuptools.build_meta"

setup.cfg

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
[metadata]
2+
name = virtual_lab
3+
version = 0.0.1
4+
author = ngr-francesco
5+
6+
[options]
7+
install_requires=
8+
numpy
9+
matplotlib
10+
packages = find:
11+
exclude = logo

0 commit comments

Comments
 (0)