Skip to content

Commit dea5e76

Browse files
committed
chore(repo): repo structure in README + nbs to notebooks/
1 parent ba799b0 commit dea5e76

File tree

3 files changed

+5
-15
lines changed

3 files changed

+5
-15
lines changed

README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,27 +46,17 @@ The examples have been setup to run online in Jupyter notebooks via binder [![Bi
4646
.
4747
├── binder
4848
│   └── environment.yml
49-
├── CHANGES.md
49+
├── CHANGELOG.md
5050
├── CITATION.cff
5151
├── LICENSE
5252
├── notebooks
53-
│   └── test_package.ipynb
54-
├── pyproject.toml
55-
├── README.md
56-
├── tests
57-
│   └── test_datasets.ipynb
58-
│   └── test_model.ipynb
59-
└── treat_sim
60-
├── data
61-
│   └── ed_arrivals.csv
62-
│   └── ed_arrivals_scenario1.csv
63-
├── __init__.py
64-
├── datasets.py
65-
├── distributions.py
66-
└── model.py
53+
│   ├── 01_linting_notebooks.ipynb
54+
│   └── 02_notebook_to_format.ipynb
55+
└── README.md
6756
```
6857

6958
* `binder/` - contains the environment.yml file (sim) and all dependencies managed via conda, used to set-up the notebooks on Binder.
59+
* `notebooks/` contains the Jupyter tips notebooks
7060
* `CHANGES.md` - changelog with record of notable changes to project between versions.
7161
* `CITATION.cff` - citation information for the package.
7262
* `LICENSE` - details of the MIT permissive license of this work.

0 commit comments

Comments
 (0)