Skip to content

Add Quarto-based documentation site for physics serialization formats#1

Draft
mmikhasenko with Copilot wants to merge 3 commits into
mainfrom
copilot/add-markdown-collection-html
Draft

Add Quarto-based documentation site for physics serialization formats#1
mmikhasenko with Copilot wants to merge 3 commits into
mainfrom
copilot/add-markdown-collection-html

Conversation

Copilot AI commented Oct 20, 2025

Copy link
Copy Markdown

This PR implements a comprehensive documentation website that gathers links and resources on serialization formats and domain-specific languages (DSLs) used across multiple physics domains.

Overview

The repository now contains a collection of Markdown documents that are automatically converted to hyperlinked HTML pages using Quarto. The site is built and deployed via GitHub Actions to GitHub Pages.

What's Included

Domain-Specific Documentation (7 pages, ~7,600 words total)

Each page provides detailed information about data formats, software frameworks, and DSLs specific to that physics domain:

  • Lattice Physics: ILDG/LIME formats, Chroma, Grid, QDP/C++, tmLQCD
  • Hadron Physics: ROOT, HIPO, AmpTools, GENIE, LHAPDF, partial wave analysis formats
  • Nuclear Physics: ENDF, ACE, MCNP, Geant4, TALYS, EXFOR/ENSDF databases
  • Astrophysics: FITS, HDF5, VOTable, simulation formats (Gadget, RAMSES, Enzo)
  • Laser Physics: EPOCH, WarpX, openPMD, PIConGPU, SDF, ADIOS2
  • Particle Physics: ROOT, HepMC, LHEF, GDML, PODIO, EDM4hep, Delphes
  • Neutrino Physics: GENIE, LArSoft, art framework, WCSim, GLoBES

General Resources

  • Serialization Formats Overview: Common formats used across domains (HDF5, ROOT, NetCDF, FITS, JSON, XML, YAML, Protocol Buffers, Parquet)
  • Cross-references: Extensive linking between related pages and to external documentation
  • Best Practices: Guidelines for choosing and using formats in each domain

Technical Implementation

  • Framework: Quarto for static site generation
  • Theme: Cosmo with custom CSS styling
  • Navigation: Organized navbar with dropdown menus
  • CI/CD: GitHub Actions workflow that builds on every push
  • Deployment: Automatic deployment to GitHub Pages (when merged to main)

Files Added

  • _quarto.yml - Quarto project configuration
  • index.qmd - Landing page
  • *-physics.qmd - Seven domain-specific pages
  • serialization-formats.qmd - General overview
  • styles.css - Custom styling
  • .github/workflows/publish.yml - CI/CD workflow
  • CONTRIBUTING.md - Contribution guidelines
  • .gitignore - Build artifact exclusion

After Merging

Once merged to main, the site will be automatically built and deployed. The live site will be available at:

https://democratizing-models-project.github.io/Format-Landscape/

Note: Ensure GitHub Pages is enabled in repository Settings (Settings → Pages → Source: GitHub Actions).

Contributing

The documentation can be easily extended by editing the .qmd files. See CONTRIBUTING.md for detailed guidelines on adding new formats, domains, or improving existing content.

Original prompt

A simple collection of Markdown documents that turns into hyperlinked html pages with CI using quarto.

It gathers links and resources on serialization formats and domain specific languages used in Lattice, Hadron, Nuclear, Astro, Laser, Particle, Neutrino physics.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Copilot AI self-assigned this Oct 20, 2025
Copilot AI and others added 2 commits October 20, 2025 19:18
Co-authored-by: mmikhasenko <22725744+mmikhasenko@users.noreply.github.com>
Co-authored-by: mmikhasenko <22725744+mmikhasenko@users.noreply.github.com>
Copilot AI changed the title [WIP] Add Markdown collection for hyperlinked HTML pages Add Quarto-based documentation site for physics serialization formats Oct 20, 2025
Copilot AI requested a review from mmikhasenko October 20, 2025 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants