Skip to content

README.md

Latest commit

 

History

History
74 lines (44 loc) · 1.93 KB

README.md

File metadata and controls

74 lines (44 loc) · 1.93 KB

ROOCS Website

ROOCS Website is the front page for the roocs project.

Contributing

Contributions are welcome. Feel free to open a pull request with changes.

Running it Locally

Preview changes locally before opening a pull request. This site uses MkDocs.

# create conda environment
conda env create
conda activate roocs

# build docs
mkdocs build

# serve docs locally
mkdocs serve

Open browser: http://127.0.0.1:8000

Extract Monthly Download Stats

Use scripts/extract_stats.py to aggregate monthly request/download metrics from dashboard HTML files.

Use the same conda environment setup shown above (conda env create, conda activate roocs), then run:

python scripts/extract_stats.py --start 2025-04 --end 2026-02 --site dkrz --quiet

This writes:

docs/downloads/stats/<site>-monthly-<start>_to_<end>_metrics.csv docs/downloads/stats/<site>-quarterly-<start>_to_<end>_metrics.csv docs/downloads/stats/<site>-monthly-<start>_to_<end>_visits.csv

Notes:

  • downloads_size is in MB.

Generate Yearly Dashboard Report

Generate docs/dashboard/dashboard-<year>.md from the current quarterly stats files:

python scripts/generate_dashboard_report.py --year 2026 --quiet

Extended usage:

python scripts/generate_dashboard_report.py 2026
python scripts/generate_dashboard_report.py --year 2026 --stats-dir docs/downloads/stats --output docs/dashboard/dashboard-2026.md

Input parameter:

  • year (for example: 2026)

Deployment

Pull requests merged to the main branch are automatically deployed to the production website.

License

The content of this project itself is licensed under the Creative Commons Attribution-ShareAlike 4.0 International license, and the underlying source code used to format and display that content is licensed under the MIT license.