Skip to content

Commit 48453cd

Browse files
authored
Minor clean-up (#17)
* Examples folder was removed in InstituteforDiseaseModeling/emod-api-old#752 * Modules pyyaml and graphviz are unused; numpy comes with matplotlib and scipy * No need for parse library or prodict * Link to testing documentation.
1 parent 888ce49 commit 48453cd

18 files changed

+17
-814
lines changed

README.md

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# emod-api
2-
Python library/utilities/tools for interacting with DTK input and output files
2+
Python library/utilities/tools for interacting with EMOD input and output files
33

44
Developer note: Any .py file in emod_api will be included in the package.
55

6-
![](https://github.com/institutefordiseasemodeling/emod-api/workflows/Package%20and%20test%20on%20Ubuntu/badge.svg)
7-
![](https://github.com/institutefordiseasemodeling/emod-api/workflows/Package%20and%20test%20on%20Windows/badge.svg)
6+
[![Package and test on Ubuntu](https://github.com/EMOD-Hub/emod-api/actions/workflows/build_test_ubuntu.yaml/badge.svg)](https://github.com/EMOD-Hub/emod-api/actions/workflows/build_test_ubuntu.yaml)
7+
[![Package and test on windows](https://github.com/EMOD-Hub/emod-api/actions/workflows/build_test_windows.yaml/badge.svg)](https://github.com/EMOD-Hub/emod-api/actions/workflows/build_test_windows.yaml)
88

99
## Documentation
1010

@@ -27,20 +27,13 @@ To build the documentation locally, do the following:
2727
2828
### Linux
2929
30-
emod-api can use Snappy [de]compression (python-snappy, actually) as necessary if it is installed
31-
which requires libdev-snappy (Debian/Ubuntu) or snappy-devel (RedHat/CentOS) on Linux.
30+
emod-api can use Snappy [de]compression (python-snappy) as necessary if it is installed which requires libdev-snappy (Debian/Ubuntu) or snappy-devel (RedHat/CentOS) on Linux.
3231
3332
Ubuntu: ```[sudo] apt install libdev-snappy```
3433
3534
CentOS: ```[sudo] yum install snappy-devel``` (not yet tested)
3635
37-
### Windows
38-
39-
If Snappy compression support is desired or needed, consider downloading and installing the latest
40-
python-snappy package for Windows from Christoph Gohlke's python package website:
41-
https://www.lfd.uci.edu/~gohlke/pythonlibs/#python-snappy
42-
43-
## user stories
36+
## User Stories
4437
4538
Input
4639
- User wants to be able to create a minimal working config.json for any sim type guaranteed to work with a given Eradication binary.
@@ -83,24 +76,19 @@ Output
8376
8477
### Running tests
8578
86-
`python3 tests/channel_reports.py`
87-
`python3 tests/serialization.py`
88-
`python3 tests/spatial_reports.py`
89-
`python3 tests/weather_files.py`
79+
Please see the documentation for [testing](/tests/README.md).
9080
9181
9282
# Community
9383
9484
The EMOD Community is made up of researchers and software developers, primarily focused on malaria and HIV research.
95-
We value mutual respect, openness, and a collaborative spirit. If these values resonate with you,
96-
we invite you to join our EMOD Slack Community by completing this form:
85+
We value mutual respect, openness, and a collaborative spirit. If these values resonate with you, we invite you to join our EMOD Slack Community by completing this form:
9786
9887
https://forms.office.com/r/sjncGvBjvZ
9988
10089
10190
# Disclaimer
10291
10392
The code in this repository was developed by IDM and other collaborators to support our joint research on flexible agent-based modeling.
104-
We've made it publicly available under the MIT License to provide others with a better understanding of our research and an opportunity to build upon it for
105-
their own work. We make no representations that the code works as intended or that we will provide support, address issues that are found, or accept pull requests.
106-
You are welcome to create your own fork and modify the code to suit your own modeling needs as permitted under the MIT License.
93+
We've made it publicly available under the MIT License to provide others with a better understanding of our research and an opportunity to build upon it for their own work. We make no representations that the code works as intended or that we will provide support, address issues that are found, or accept pull requests.
94+
You are welcome to create your own fork and modify the code to suit your own modeling needs as permitted under the MIT License.

examples/__init__.py

Whitespace-only changes.

examples/config/from_schema.py

Lines changed: 0 additions & 8 deletions
This file was deleted.

examples/default_from_schema.py

Lines changed: 0 additions & 4 deletions
This file was deleted.

examples/insetchart.py

Lines changed: 0 additions & 82 deletions
This file was deleted.

examples/intervention_from_schema.py

Lines changed: 0 additions & 8 deletions
This file was deleted.

0 commit comments

Comments
 (0)