Skip to content

Commit 0258812

Browse files
committed
Add install instructions and dashboard
1 parent 4fa3ec5 commit 0258812

File tree

1 file changed

+28
-1
lines changed

1 file changed

+28
-1
lines changed

README.md

Lines changed: 28 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,34 @@ SimDec reveals the nature of causalities and interaction effects in the model.
2222
See our [publications](https://www.simdec.fi/publications) and join our
2323
[discord community](https://discord.gg/54SFcNsZS4).
2424

25-
...
25+
## Python API
26+
The library is distributed on PyPi and can be installed with:
27+
28+
pip install simdec
29+
30+
To install the development version, download the source and from the root of
31+
the repository:
32+
33+
pip install -e .[dev]
34+
35+
## Dashboard
36+
A live dashboard is available at:
37+
38+
https://simdec.io
39+
40+
### Local use
41+
42+
The dashboard can be run locally using:
43+
44+
make serve
45+
46+
### Deployment
47+
48+
The live version of the dashboard is hosted on GCP. To deploy a new version:
49+
50+
PANEL_TOKEN=... make production
51+
52+
###
2653

2754
## Citations
2855

0 commit comments

Comments
 (0)