Skip to content

Commit eed5e08

Browse files
committed
adding introduction use case explanation to README
1 parent d77f7b3 commit eed5e08

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

README.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,24 @@
22

33
# Delphi
44

5-
Delphi is a framework for executing causal analysis graphs (CAGs) for DARPA's
6-
World Modelers program. Here is an example of what it looks like:
5+
Delphi is a framework for assembling, exporting and executing executable DBN (dynamic Bayesian Network) models built for the DARPA World Modelers Program.
6+
7+
The followng instructions describe how to install, following by usage information.
8+
9+
The general use case involves the following
10+
11+
1. Create a model from a set of INDRA statements. Use the
12+
`--create_model` flag to create the model. Optionally combine this
13+
with the `--indra_statements` input parameter to specify the path to
14+
the INDRA statements. By default, create_model will load a provided
15+
set of INDRA statements included as a pickled python file in
16+
`data/sample_indra_statements.pkl`. This generates the model; by
17+
default this generates the `dbn_model/` directory and files, as
18+
described below.
19+
20+
2. Execute a model.
21+
22+
See Usage, below, for more details.
723

824
# Installation
925

@@ -51,6 +67,8 @@ optional arguments:
5167
5268
```
5369

70+
## Create model
71+
5472
To create a model, do:
5573

5674
```bash
@@ -111,6 +129,8 @@ crop yield,100.0
111129
∂(crop yield)/∂t,1.0
112130
```
113131

132+
## Execute model
133+
114134
To execute the model, do
115135

116136
```bash

0 commit comments

Comments
 (0)