Skip to content

Commit 81224a2

Browse files
committed
Minor udpate to README and changes to dependencies for diagramming
1 parent 3cf8d08 commit 81224a2

4 files changed

Lines changed: 18 additions & 29 deletions

File tree

README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -139,21 +139,21 @@ directory of the SIRA code, and the model of interest is in the location
139139

140140
The following code runs the simulation and the post processing simultanrously:
141141

142-
```bash
143-
python -m sira -d scenario_dir/ci_model_x -sfl
144-
```
142+
```bash
143+
python -m sira -d scenario_dir/ci_model_x -sfl
144+
```
145145

146146
To run only the Monte Carlo simulation without post-processing:
147147

148-
```bash
149-
python -m sira -d scenario_dir/ci_model_x -s
150-
```
148+
```bash
149+
python -m sira -d scenario_dir/ci_model_x -s
150+
```
151151

152152
To run both the model fitting and the loss analysis code:
153153

154-
```bash
155-
python -m sira -d scenario_dir/ci_model_x -fl
156-
```
154+
```bash
155+
python -m sira -d scenario_dir/ci_model_x -fl
156+
```
157157

158158
Note that the model fitting and loss analysis steps require that the
159159
initial simulation be run first so that it has the initial output data
@@ -279,15 +279,15 @@ Recommendation:
279279
To run the tests, user needs to be in the root directory of the code,
280280
e.g. `~/code/sira`. Then simply run:
281281

282-
```bash
283-
pytest
284-
```
282+
```bash
283+
pytest
284+
```
285285

286286
If you want to explicitly ask `pytest` to run coverage reports, then run:
287287

288-
```bash
289-
pytest --cov-report term --cov=sira tests/
290-
```
288+
```bash
289+
pytest --cov-report term --cov=sira tests/
290+
```
291291

292292
If you are using docker as described above, you can do this from within the
293293
sira container.
Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1 @@
1-
blockdiag
2-
seqdiag
3-
actdiag
4-
sphinxcontrib-actdiag
5-
sphinxcontrib-blockdiag
6-
sphinxcontrib-seqdiag
1+
sphinxcontrib-mermaid

installation/requirements-docs.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
setuptools
12
Sphinx
23
sphinx-rtd-theme
34
pybtex

installation/sira_req.txt

Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
1-
actdiag
21
alabaster
32
adjustText
43
awscli
54
babel
6-
blockdiag
75
botocore
86
cairocffi>=1.4.0
97
codecov
@@ -72,12 +70,7 @@ linkify-it-py
7270
katex
7371

7472
# Diagrams
75-
blockdiag
76-
seqdiag
77-
actdiag
78-
sphinxcontrib-actdiag
79-
sphinxcontrib-blockdiag
80-
sphinxcontrib-seqdiag
73+
sphinxcontrib-mermaid
8174

8275
# Development and QA
8376
pytest

0 commit comments

Comments
 (0)