Skip to content

Commit a9429e7

Browse files
hasanarihasanari
committed
WP7 Documentation Hub
Sphinx documentation site for all WP7 demonstrators. Removed stale SLURM/HPC references.
0 parents  commit a9429e7

47 files changed

Lines changed: 11194 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.github/workflows/pages.yml‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: Deploy Sphinx to GitHub Pages
2+
3+
on:
4+
push:
5+
branches: [main, master]
6+
7+
permissions:
8+
contents: read
9+
pages: write
10+
id-token: write
11+
12+
concurrency:
13+
group: pages
14+
cancel-in-progress: true
15+
16+
jobs:
17+
build:
18+
runs-on: ubuntu-latest
19+
steps:
20+
- uses: actions/checkout@v4
21+
- uses: actions/setup-python@v5
22+
with:
23+
python-version: "3.11"
24+
- run: |
25+
pip install --upgrade pip
26+
pip install -r requirements.txt
27+
- run: sphinx-build -b html documents build/html
28+
- uses: actions/upload-pages-artifact@v3
29+
with:
30+
path: build/html
31+
32+
deploy:
33+
needs: build
34+
runs-on: ubuntu-latest
35+
environment:
36+
name: github-pages
37+
url: ${{ steps.deployment.outputs.page_url }}
38+
steps:
39+
- id: deployment
40+
uses: actions/deploy-pages@v4

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
build/
2+
3+
# Added for GitHub migration
4+
.coverage
5+
.pytest_cache/
6+
_build/

‎.zenodo.json‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
"title": "NAIC WP7 Documentation Hub",
3+
"description": "Central documentation site for NAIC Work Package 7 demonstrators including FAQ, team info, and deliverables.",
4+
"creators": [
5+
{"name": "Arief, Hasan Asyari", "affiliation": "NORCE Norwegian Research Centre"},
6+
{"name": "Johannsen, Klaus", "affiliation": "NORCE Norwegian Research Centre"}
7+
],
8+
"keywords": ["NAIC", "WP7", "documentation"],
9+
"license": {"id": "GPL-3.0-only"},
10+
"upload_type": "software",
11+
"access_right": "open"
12+
}

‎LICENSE‎

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
Dual License
2+
3+
This repository uses a dual license:
4+
5+
1. TUTORIAL CONTENT (content/, *.md, *.ipynb files):
6+
Creative Commons Attribution-NonCommercial 4.0 International (CC BY-NC 4.0)
7+
8+
2. SOFTWARE CODE (*.py, *.html, *.sh files):
9+
GNU General Public License v3.0 only (GPL-3.0-only)
10+
11+
Copyright (c) Sigma2 / NAIC
12+
13+
================================================================================
14+
15+
CC BY-NC 4.0 — Tutorial Content License
16+
17+
Creative Commons Attribution-NonCommercial 4.0 International
18+
19+
You are free to:
20+
Share — copy and redistribute the material in any medium or format
21+
Adapt — remix, transform, and build upon the material
22+
23+
Under the following terms:
24+
Attribution — You must give appropriate credit, provide a link to the
25+
license, and indicate if changes were made.
26+
NonCommercial — You may not use the material for commercial purposes.
27+
28+
Full text: https://creativecommons.org/licenses/by-nc/4.0/legalcode
29+
30+
================================================================================
31+
32+
GPL-3.0-only — Software Code License
33+
34+
GNU GENERAL PUBLIC LICENSE
35+
Version 3, 29 June 2007
36+
37+
Copyright (C) 2007 Free Software Foundation, Inc.
38+
<https://fsf.org/>
39+
40+
Everyone is permitted to copy and distribute verbatim copies of this
41+
license document, but changing it is not allowed.
42+
43+
This program is free software: you can redistribute it and/or modify
44+
it under the terms of the GNU General Public License as published by
45+
the Free Software Foundation, version 3.
46+
47+
This program is distributed in the hope that it will be useful,
48+
but WITHOUT ANY WARRANTY; without even the implied warranty of
49+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
50+
GNU General Public License for more details.
51+
52+
You should have received a copy of the GNU General Public License
53+
along with this program. If not, see <https://www.gnu.org/licenses/>.
54+
55+
Full text: https://www.gnu.org/licenses/gpl-3.0.txt

‎Makefile‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line, and also
5+
# from the environment for the first two.
6+
SPHINXOPTS ?=
7+
SPHINXBUILD ?= sphinx-build
8+
SOURCEDIR = documents
9+
BUILDDIR = build
10+
11+
# Put it first so that "make" without argument is like "make help".
12+
help:
13+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
14+
15+
.PHONY: help Makefile
16+
17+
# Catch-all target: route all unknown targets to Sphinx using the new
18+
# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
19+
%: Makefile
20+
@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

‎README.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# WP7 Demonstrators - Documentation
2+
3+
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19184233.svg)](https://doi.org/10.5281/zenodo.19184233)
4+
5+
6+
Documentation site for NAIC Work Package 7 (WP7) - Demonstrators.
7+
8+
WP7 is responsible for the design and implementation of demonstrators that showcase
9+
the abilities of NAIC. Each demonstrator connects to a research community, formulates
10+
a use case as a ML/AI task, and provides a complete pipeline from data to results.
11+
12+
## Rendered Documentation
13+
14+
[View the documentation site](https://naicno.github.io/wp7-documentation)
15+
16+
## Use Case Demonstrators
17+
18+
| UC | Title | Repository | Tutorial | DOI | Status |
19+
|----|-------|-----------|----------|-----|--------|
20+
| UC1 | Climate Indices Teleconnection | [wp7-UC1-climate-indices-teleconnection](https://github.com/NAICNO/wp7-UC1-climate-indices-teleconnection) | [Tutorial](https://naicno.github.io/wp7-UC1-climate-indices-teleconnection/) | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19184215.svg)](https://doi.org/10.5281/zenodo.19184215) | Completed |
21+
| UC2 | PEM Electrolyzer PINN Optimizer | [wp7-UC2-pem-electrolyzer-digital-twin](https://github.com/NAICNO/wp7-UC2-pem-electrolyzer-digital-twin) | [Tutorial](https://naicno.github.io/wp7-UC2-pem-electrolyzer-digital-twin/) | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19184217.svg)](https://doi.org/10.5281/zenodo.19184217) | Completed |
22+
| UC3 | Pseudo-Hamiltonian Neural Networks | [wp7-UC3-pseudo-hamiltonian-neural-networks](https://github.com/NAICNO/wp7-UC3-pseudo-hamiltonian-neural-networks) | [Tutorial](https://naicno.github.io/wp7-UC3-pseudo-hamiltonian-neural-networks/) | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19184219.svg)](https://doi.org/10.5281/zenodo.19184219) | Completed |
23+
| UC4 | 3D Medical Image Registration | [wp7-UC4-medical-image-registration](https://github.com/NAICNO/wp7-UC4-medical-image-registration) | [Tutorial](https://naicno.github.io/wp7-UC4-medical-image-registration/) | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19184221.svg)](https://doi.org/10.5281/zenodo.19184221) | Completed |
24+
| UC5 | Graph-Based Classification of AIS Data | [wp7-UC5-ais-classification-gnn](https://github.com/NAICNO/wp7-UC5-ais-classification-gnn) | [Tutorial](https://naicno.github.io/wp7-UC5-ais-classification-gnn/) | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19184225.svg)](https://doi.org/10.5281/zenodo.19184225) | Completed |
25+
| UC6 | Multi-Modal Optimization | [wp7-UC6-multimodal-optimization](https://github.com/NAICNO/wp7-UC6-multimodal-optimization) | [Tutorial](https://naicno.github.io/wp7-UC6-multimodal-optimization/) | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19184224.svg)](https://doi.org/10.5281/zenodo.19184224) | Completed |
26+
| UC7 | Latent Representation of PDE Solutions | [wp7-UC7-latent-pde-representation](https://github.com/NAICNO/wp7-UC7-latent-pde-representation) | [Tutorial](https://naicno.github.io/wp7-UC7-latent-pde-representation/) | [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.19184227.svg)](https://doi.org/10.5281/zenodo.19184227) | Completed |
27+
28+
## Summary Deliverables
29+
30+
| ID | Deliverable | Repository |
31+
|----|-------------|------------|
32+
| D7.10 | Summary of completed demonstrators | [wp7-D710-deliverable-report](https://github.com/NAICNO/wp7-D710-deliverable-report) |
33+
| D7.11 | Summary of contributions for training and documentation | [wp7-D711-summary](https://github.com/NAICNO/wp7-D711-summary) |
34+
35+
## Building Locally
36+
37+
```bash
38+
pip install -r requirements.txt
39+
sphinx-build -b html documents build/html
40+
```
41+
42+
The built site will be in `build/html/`.

‎documents/_static/clearchache.js‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
// Clear browser cache
2+
//
3+
//
4+
function clearCache() {
5+
if (typeof window !== 'undefined' && 'caches' in window) {
6+
// Clearing cache for modern browsers
7+
caches.keys().then(function(cacheNames) {
8+
cacheNames.forEach(function(cacheName) {
9+
caches.delete(cacheName);
10+
});
11+
});
12+
}
13+
14+
// Clearing cache for older browsers
15+
if (typeof window !== 'undefined' && 'localStorage' in window) {
16+
window.localStorage.clear();
17+
}
18+
19+
// Reload the page to ensure the cache is cleared
20+
window.location.reload(true);
21+
}

0 commit comments

Comments
 (0)