|
5 | 5 |
|
6 | 6 | Compartmental Epidemic Models in Python |
7 | 7 |
|
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | + |
| 12 | + |
| 13 | + |
| 14 | + |
| 15 | + |
8 | 16 |
|
9 | 17 | --- |
10 | 18 |
|
11 | 19 | ## Table of contents[](#toc) |
12 | 20 | - [Installation](#installation) |
13 | 21 | - [Tech Stack](#tech) |
14 | | -- [Usage](#usage) |
| 22 | +- [Basic Usage](#usage) |
| 23 | +- [Documentation](#documentation) |
15 | 24 | - [Contributing](#contributing) |
16 | 25 | - [License](#license) |
17 | 26 |
|
@@ -46,7 +55,7 @@ Here's a brief high-level overview of the tech stack the `epidemik` package uses |
46 | 55 | --- |
47 | 56 |
|
48 | 57 |
|
49 | | -## Usage[](#usage) |
| 58 | +## Basic Usage[](#usage) |
50 | 59 |
|
51 | 60 | `epidemik` provides three main modules, `EpiModel`, `NetworkEpiModel` and `MetaEpiModel`, usually imported directly from the `epidemik` package using the module name |
52 | 61 |
|
@@ -123,6 +132,15 @@ which produces: |
123 | 132 |
|
124 | 133 | --- |
125 | 134 |
|
| 135 | + |
| 136 | +## Documentation[](#documentation) |
| 137 | + |
| 138 | +The full documentation for this project is available at ReadTheDocs in [html](https://epidemik.readthedocs.io/), [PDF](https://epidemik.readthedocs.io/_/downloads/en/latest/pdf/) and [ePub](https://epidemik.readthedocs.io/_/downloads/en/latest/epub/) formats. |
| 139 | + |
| 140 | +<div align="right">[ <a href="#table-of-contents">↑ Back to top ↑</a> ]</div> |
| 141 | + |
| 142 | +--- |
| 143 | + |
126 | 144 | ## Contributing[](#contributing) |
127 | 145 |
|
128 | 146 | Pull requests are welcome. For major changes, please open an issue first |
|
0 commit comments