A simple template for creating DES models in Python, within a reproducible analytical pipeline (RAP)
Click on Use this template to initialise new repository.
A README template is provided at the end of this file.
⚠️ Work in progress
TBC. Notes:
- Purpose of template.
- Explanation of implementation (e.g. SimPy, cite).
- Link to STARS.
- Link to relevant publication.
- Link to https://github.com/pythonhealthdatascience/rap_des/.
Click on Use this template to initialise new repository. Then clone onto your machine following the standard syntax:
# Clone project
git clone https://github.com/username/repo
cd repo
Set-up the provided conda environment.
# Create conda environment
conda env create --file environment.yaml
| Contributor | ORCID | GitHub |
|---|---|---|
| Amy Heather |  |
https://github.com/amyheather |
This template is licensed under the MIT License.
MIT License
Copyright (c) 2024 STARS Project Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
This project was developed as part of the project STARS: Sharing Tools and Artefacts for Reproducible Simulations. It is supported by the Medical Research Council [grant number MR/Z503915/1].
DELETE EVERYTHING ABOVE FOR YOUR PROJECT
TBC. Provide instructions and basic example.
TBC. Provide instructions and basic example.
TBC. Provide instructions and basic example.
TBC. Provide instructions and basic example for how to cite their project. Provide correct citation for this template.