You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This repository is a template for ESIIL Working Groups.
3
+
This repository serves as the central collaboration and documentation hub for the **EdgeSS (Sensor Synthesis at the Edge: Scalable Environmental Insights from Real-time Data)** project.
4
4
5
-
This template is designed as one connected system:
5
+
EdgeSS brings together environmental scientists, data scientists, AI researchers, and cyberinfrastructure experts to develop scalable approaches for integrating real-time environmental sensor data, edge computing, and artificial intelligence. The project focuses on advancing environmental monitoring and decision-making through distributed sensing systems and interoperable data workflows.
6
6
7
-
- The repository is where the science happens.
8
-
- The website is where the science is shared.
9
-
- GitHub connects them through commits, version history, and publishing.
7
+
The repository supports project coordination, technical documentation, working group activities, meeting materials, and public-facing project communication through an automatically generated website.
10
8
11
-
## How this repository is organized
9
+
## Project Objectives
12
10
13
-
The repository has two connected layers. Top-level files configure the project and its automation. The `docs/` folder contains the website content. `mkdocs.yml` tells MkDocs how to turn that content into the public site. Analysis folders hold the working scientific materials that generate the results shown on the website.
11
+
EdgeSS is organized around three environmental challenge areas:
12
+
13
+
***Invasive Species Monitoring** – Tracking and understanding the spread of invasive organisms such as the Spotted Lanternfly using distributed sensing networks and AI-enabled detection systems.
14
+
***Forest Disturbance and Ecosystem Response** – Investigating how wildfire, drought, insects, and disease influence vegetation dynamics, phenology, and ecological resilience.
15
+
***Air Quality and Environmental Health** – Examining spatial and temporal patterns in air pollution using real-time environmental sensing and edge-based analytics.
16
+
17
+
The project leverages emerging cyberinfrastructure, including smart sensors, edge computing platforms, environmental observatories, and AI-driven data processing pipelines to generate actionable environmental insights at scale.
18
+
19
+
---
20
+
21
+
## Repository Structure
22
+
23
+
This repository is organized as a connected system that supports both project development and public dissemination.
14
24
15
25
```text
16
26
.
17
-
├── README.md # Repository overview and setup notes
18
-
├── mkdocs.yml # Website navigation, theme, plugins, and edit links
19
-
├── docs/ # Markdown source for the public website
20
-
├── scripts/ # Build helpers and site health checks
21
-
├── templates/ # Reusable meeting-note templates
22
-
├── containers/ # Optional runtime and environment setup
23
-
└── other working folders # Add data, notebooks, scripts, workflows, outputs, or figures here as the group's science grows
27
+
├── README.md # Project overview and repository guidance
28
+
├── mkdocs.yml # Website configuration and navigation
29
+
├── docs/ # Public-facing project website content
30
+
├── scripts/ # Site utilities and automation scripts
31
+
├── templates/ # Meeting notes and project templates
32
+
├── containers/ # Development and deployment environments
33
+
└── project folders # Research materials, workflows, data products, and analyses
24
34
```
25
35
26
-
Use these rules of thumb when deciding where to put something:
36
+
### Documentation Layer
37
+
38
+
The `docs/` directory contains the source content for the EdgeSS website. Content in this directory is automatically rendered into a public project website using MkDocs.
39
+
40
+
Examples include:
41
+
42
+
* Project overview and goals
43
+
* Working group information
44
+
* Meeting notes and project updates
45
+
* Technical documentation
46
+
* Training materials and resources
47
+
* Project deliverables and outputs
48
+
49
+
### Research and Development Layer
50
+
51
+
Additional project folders contain the scientific and technical work that supports EdgeSS activities, including:
52
+
53
+
* Data workflows
54
+
* Analysis notebooks
55
+
* Edge computing experiments
56
+
* Sensor integration documentation
57
+
* AI and machine learning workflows
58
+
* Figures, reports, and deliverables
59
+
60
+
---
61
+
62
+
## Frequently Updated Files
63
+
64
+
Common files and locations that project contributors may edit include:
27
65
28
-
- Top-level files and folders are for project configuration, automation, contribution guidance, licensing, environment setup, and repo-wide metadata.
29
-
-`docs/` is for public website pages and assets. Markdown files here become website pages through MkDocs.
30
-
-`mkdocs.yml` controls how the website is rendered, including navigation, theme settings, plugins, and GitHub edit links.
31
-
- Scientific working materials belong in working folders such as data, notebooks, scripts, workflows, outputs, and figure directories.
66
+
*`docs/index.md` – Project homepage
67
+
*`docs/work-plan.md` – Project roadmap, milestones, and meeting tracking
68
+
*`docs/how-this-group-works.md` – Collaboration guidelines and team practices
69
+
*`docs/esiil-resources/` – Shared ESIIL resources and training materials
70
+
*`docs/instructions/` – Contributor and GitHub guidance
71
+
*`docs/resources/` – Reference materials and supporting documentation
32
72
33
-
## Common places to edit
73
+
---
34
74
35
-
-`docs/index.md` is the homepage for the public site.
36
-
-`docs/work-plan.md` tracks milestones, meetings, and outputs for the working group.
37
-
-`docs/how-this-group-works.md` holds collaboration norms, working group guides, and data and methods galleries.
38
-
-`docs/esiil-resources/team-trainings.md` and `docs/esiil-resources/code-of-conduct.md` are under ESIIL and Team Resources.
39
-
-`docs/community-care.md` is nested under ESIIL and Team Resources and links to ESIIL community care and team science resources.
40
-
-`docs/instructions/` contains practical working group instructions for GitHub, persistent storage, lifecycle phases, and landmarks.
41
-
-`docs/resources/` contains reusable resource guides such as the Cloud Triangle and Cite and Reuse guidance.
42
-
-`docs/assets/images/slots/` contains named image slots for the homepage and other shared visuals.
43
-
-`docs/assets/images/process/` contains folder-driven process galleries that render automatically on the site.
75
+
## Local Development
44
76
45
-
## Preview locally
77
+
Install dependencies and start a local preview of the website:
46
78
47
79
```bash
48
80
pip install -r requirements.txt
@@ -51,61 +83,72 @@ python scripts/site_health.py
51
83
mkdocs serve
52
84
```
53
85
54
-
## Build site
86
+
The site will be available locally and automatically update as documentation changes are made.
87
+
88
+
---
89
+
90
+
## Building the Site
91
+
92
+
Generate a production build of the website:
55
93
56
94
```bash
57
95
python scripts/generate_image_slots.py
58
96
python scripts/site_health.py
59
97
mkdocs build --strict --clean
60
98
```
61
99
62
-
## Swapping homepage images
100
+
---
101
+
102
+
## Managing Images and Visual Assets
103
+
104
+
The website uses semantic image slots to simplify updating project visuals without modifying Markdown references.
105
+
106
+
### Homepage and Shared Images
107
+
108
+
1. Navigate to the appropriate folder in `docs/assets/images/slots/`
109
+
2. Replace the existing image with a new file
110
+
3. Run:
111
+
112
+
```bash
113
+
python scripts/generate_image_slots.py
114
+
```
115
+
116
+
4. Commit both the image and regenerated references
63
117
64
-
The site uses semantic image slots so Working Group members do not need to edit Markdown links every time an image changes.
118
+
### Process Galleries
65
119
66
-
1. Open the relevant folder in `docs/assets/images/slots/`.
67
-
2. Delete the old image file.
68
-
3. Add one new `.png`, `.jpg`, `.jpeg`, `.webp`, or `.svg` file.
69
-
4. Run `python scripts/generate_image_slots.py`.
70
-
5. Commit the image change and the regenerated slot references.
120
+
Process galleries automatically render content placed in:
71
121
72
-
If a slot folder contains multiple images, the generator uses the first image alphabetically and the site health report will warn you to clean it up. The cleanest workflow is still one image per slot folder.
122
+
```text
123
+
docs/assets/images/process/
124
+
```
73
125
74
-
## Using process galleries
126
+
Supported content includes:
75
127
76
-
Process galleries are folder-driven. Add files to a gallery folder, commit them, and the site updates automatically.
1. Open the relevant folder in `docs/assets/images/process/`.
79
-
2. Add images or supported deliverable files.
80
-
3. Optionally add a `captions.txt` file with lines like `filename.png | Caption text`.
81
-
4. Run `python scripts/generate_image_slots.py`.
82
-
5. Commit the new files and the regenerated gallery includes.
131
+
Captions may be added using a `captions.txt` file.
83
132
84
-
Supported image files:
133
+
---
85
134
86
-
-`.png`
87
-
-`.jpg`
88
-
-`.jpeg`
89
-
-`.webp`
90
-
-`.svg`
135
+
## Site Health Checks
91
136
92
-
Supported linked deliverable files:
137
+
A site health report is generated during each build to help identify:
93
138
94
-
-`.pdf`
95
-
-`.html`
96
-
-`.csv`
97
-
-`.xlsx`
98
-
-`.docx`
99
-
-`.pptx`
139
+
* Missing files
140
+
* Broken references
141
+
* Placeholder content
142
+
* Navigation issues
143
+
* Incomplete template sections
100
144
101
-
## Site Health
145
+
Warnings do not prevent publication but help maintain documentation quality.
102
146
103
-
The site generates a non-blocking health report during the build.
147
+
---
104
148
105
-
The report flags common issues such as missing files, placeholder links, outdated navigation, or incomplete template fields.
149
+
## Automated Publishing
106
150
107
-
Warnings do not prevent the site from publishing. They are intended to help Working Group admins improve the site.
151
+
The EdgeSS website is automatically built and deployed through GitHub Actions whenever changes are merged into the repository.
108
152
109
-
## GitHub Pages
153
+
This allows project documentation, meeting materials, and public-facing resources to remain synchronized with ongoing project development and collaboration activities.
110
154
111
-
This site is automatically built and deployed using GitHub Actions.
0 commit comments