Skip to content

Commit 4f1e8bc

Browse files
authored
chore: Update README (#387)
* Update README * Remove hidden unicode
1 parent acb4adf commit 4f1e8bc

File tree

1 file changed

+94
-9
lines changed

1 file changed

+94
-9
lines changed

README.md

Lines changed: 94 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,102 @@
1-
# Epiverse developer website
1+
# Epiverse-TRACE Website
22

3-
This repository contains all the code, markdown files, scripts, assets, and so on used to create [the Epiverse website](https://epiverse-trace.github.io).
3+
This repository contains the source code for the [Epiverse-TRACE website](https://epiverse-trace.github.io), showcasing our ecosystem of tools for epidemic analytics and outbreak response preparedness.
44

5-
## Rendering the website
5+
## About Epiverse-TRACE
66

7-
Please ensure you have Quarto installed on your command line. You should be able to run the following and render the entire website:
7+
Epiverse-TRACE develops **robust, validated, and reliable** software tools for epidemic analytics, helping to transform how we respond to infectious disease outbreaks globally. Our mission is to build integrated, generalisable, and scalable community-driven software that addresses gaps identified during the COVID-19 pandemic.
8+
9+
### Our Ecosystem
10+
11+
We maintain R packages covering the complete epidemiological analysis pipeline:
12+
13+
- **Data Management**: Import ([`readepi`](https://epiverse-trace.github.io/readepi)), clean ([`cleanepi`](https://epiverse-trace.github.io/cleanepi)), simulate ([`simulist`](https://epiverse-trace.github.io/simulist)), and validate ([`linelist`](https://epiverse-trace.github.io/linelist)) epidemiological data
14+
- **Parameter Estimation**: Access epidemiological parameters ([`epiparameter`](https://epiverse-trace.github.io/epiparameter)), estimate case fatality ratios ([`cfr`](https://epiverse-trace.github.io/cfr)), and analyze seroprevalence ([`serofoi`](https://epiverse-trace.github.io/serofoi))
15+
- **Modeling & Analysis**: Simulate epidemic dynamics ([`epidemics`](https://epiverse-trace.github.io/epidemics)), calculate final outbreak size ([`finalsize`](https://epiverse-trace.github.io/finalsize)), and assess vaccine efficacy ([`vaccineff`](https://epiverse-trace.github.io/vaccineff))
16+
- **Specialized Tools**: Analyze transmission chains ([`epichains`](https://epiverse-trace.github.io/epichains)), superspreading events ([`superspreading`](https://epiverse-trace.github.io/superspreading)), and vector-borne diseases ([`epiCo`](https://epiverse-trace.github.io/epiCo))
17+
18+
All packages are built on methods validated through real epidemic responses including cholera, COVID-19, dengue, Ebola, and Zika outbreaks.
19+
20+
## Repository Structure
21+
22+
This website is built with [Quarto](https://quarto.org/) and features:
23+
24+
- **Blog**: Technical articles, package releases, and community updates
25+
- **Documentation**: Getting started guides and learning materials
26+
- **Resources**: How-to guides and tutorials
27+
- **Community**: Contributor profiles and team information
28+
- **Presentations**: Conference talks and workshop materials
829

930
```
10-
quarto render
11-
# individual pages
12-
quarto render <file>
31+
├── _components/ # React components for interactive elements
32+
├── _data/ # CSV files with contributor and package data
33+
├── posts/ # Blog posts and articles
34+
├── slides/ # Presentation materials
35+
├── resources/ # Documentation and guides
36+
├── _scripts/ # Data collection and automation scripts
37+
└── _templates/ # Content generation templates
1338
```
1439

15-
## Scheduling pull requests
40+
## Development Setup
41+
42+
### Prerequisites
43+
44+
- [Quarto](https://quarto.org/docs/get-started/) CLI installed
45+
- [R](https://cran.r-project.org/) (for content generation scripts)
46+
47+
### Getting Started
48+
49+
1. **Clone the repository**
50+
```bash
51+
git clone https://github.com/epiverse-trace/epiverse-trace.github.io.git
52+
cd epiverse-trace.github.io
53+
```
54+
55+
2. **Render the website**
56+
```bash
57+
# Render entire website
58+
quarto render
59+
60+
# Render individual pages
61+
quarto render <file.qmd>
62+
63+
# Preview locally
64+
quarto preview
65+
```
66+
67+
### Content Management
68+
69+
- **Blog posts**: Add new `.qmd` files to `posts/` directory
70+
- **Release posts**: Automatically upon release on GitHub
71+
- **Contributor data**: Automatically updated via `_scripts/collect_contributor_data.R`
72+
- **Package information**: Pulled from `_data/epiverse_pkgs.csv`
73+
74+
## Contributing
75+
76+
We welcome contributions! Feel encouraged to open up pull requests for small changes or existing issues. If you want to discuss a new package, [please use our discussion board first](https://github.com/orgs/epiverse-trace/discussions).
77+
78+
### Scheduling Pull Requests
79+
For time-sensitive content (e.g., blog posts), you can schedule merges by adding `/schedule <datetime>` at the end of your PR description using ISO8601 format (e.g., `/schedule 2024-12-25T10:00:00Z`).
80+
81+
## Community
82+
83+
Epiverse-TRACE is a collaborative effort involving:
84+
85+
- **London School of Hygiene & Tropical Medicine (LSHTM)**
86+
- **MRC Unit The Gambia at LSHTM**
87+
- **Universidad Javeriana** (Colombia)
88+
- **Universidad de los Andes** (Colombia)
89+
90+
Supported by the **Wellcome Trust**, **Rockefeller Foundation**, and **IDRC Canada** as part of the data.org Epiverse initiative.
91+
92+
### Connect With Us
93+
94+
- **Bluesky**: [@epiverse-trace.bsky.social](https://bsky.app/profile/epiverse-trace.bsky.social)
95+
- **GitHub**: [@epiverse-trace](https://github.com/epiverse-trace)
96+
- **R Universe**: [epiverse-trace.r-universe.dev](https://epiverse-trace.r-universe.dev/packages)
97+
- **Twitter**: [@Epiverse_TRACE](https://twitter.com/Epiverse_TRACE)
98+
- **Website**: [epiverse-trace.github.io](https://epiverse-trace.github.io)
99+
100+
## License
16101

17-
Given that we sometimes want to merge pull requests at specific times, especially for blog posts, there is the option to schedule a merge attempt. To do so, add an ISO8601 compliant datetime command as such at the end of the first post in the PR: `/schedule <datetime>` (e.g., `/schedule 2026-01-01` for January 1st, 2026).
102+
This website content is licensed under [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0/). Website code is licensed MIT. Individual software packages maintain their own licenses.

0 commit comments

Comments
 (0)