Open Modeling Foundation Standards and Governance Repository

This repository is for establishing and disseminating standards related to accessibility, interoperability, documentation, and reuse of computational models. Please see our mission and charter for more details.

How to Contribute

You can contribute to this site by following the directions at https://openmodelingfoundation.org/contribute/ - the process of proposing and accepting changes to OMF standards will be finalized once we have established our governance structure.

Agent Harness

This repository includes an agent collaboration harness for AI-assisted work.

• Canonical policy: AGENTS.md is the source of truth for agent behavior.
• Command environment for agents: run project commands in containers: look for make targets first, then the Docker Compose hugo service

For Hugo, Docsy, JavaScript, and other dependency updates, follow the dependency upgrade runbook.

Standalone open science downloads

See the prompt publication guide for ownership, the pinned Skills dependency, local previews and update checks.

Deployment

The site is deployed to GitHub Pages via the workflow at .github/workflows/gh-pages.yml. Pushes to the develop branch trigger an automated build-and-deploy.

How it works

1. The build job checks out develop, configures the Pages base URL, then builds the site inside the same Docker Compose hugo service used for local development (docker compose build --pull hugo + docker compose run --rm --no-deps --entrypoint sh hugo -c ...). The Hugo invocation itself is centralized in .github/scripts/build-site.sh, which is shared across local production-style rendering and CI workflows.
2. The deploy job receives that artifact and publishes it directly to GitHub Pages via GitHub's OIDC-based Pages API (actions/deploy-pages).

No "built" branch is used. The old approach pushed compiled HTML to a main branch using peaceiris/actions-gh-pages. That is no longer the case — the deployment artifact goes straight to GitHub's Pages infrastructure. The main branch (if it still exists in the remote) is a leftover and is no longer updated.

Repository Pages setting

The repository's Pages source must be set to GitHub Actions (not "Deploy from a branch"). In repository Settings → Pages → Build and deployment, select Source: GitHub Actions. Using "Branch: main" will not work with the current workflow.

About

This GitHub pages site is generated with hugo using the docsy theme and can be built locally by following these instructions:

Setup

The supported local workflow uses Docker and Docker Compose.

Clone this repository via git clone --recurse-submodules -j8 https://github.com/openmodelingfoundation/openmodelingfoundation.github.io.git

Docker and docker-compose installed

If you have Docker and docker-compose installed, you can use the Makefile in the repository to automatically serve a local copy of the site to test out any changes:

Build and start a docker container with a hot-reloading hugo server that you can visit in your browser at http://localhost:1313 via

% make serve

The preview uses an image-populated dependency volume at /src/node_modules. make serve recreates the container and refreshes that volume after building, so stale host packages cannot shadow the image's Bootstrap or Font Awesome files. The host node_modules directory is left untouched.

Make passes your UID/GID to Compose, so preview and maintenance containers write workspace files as your user. Hugo uses .hugo_cache/; home and npm caches use the container's /tmp. Run make serve again to recreate an older preview with these settings. See dependency maintenance for lockfile updates and handling files created by older containers.

Run the local production-style render path (equivalent to the CI shared build entrypoint):

% make render

Open a hugo shell in the docker container

% make shell

The shared build script used by CI workflows and make render is:

.github/scripts/build-site.sh

Generated content

The supported container workflows prepare the bibliography before starting Hugo. Prompt downloads are fetched, verified and published by Hugo itself. Awesome Modeling Practices refreshes once per build, with a visible warning and bibliography fallback when its upstream source is unavailable.

See generated content and freshness for preparation and refresh policies. Run make content-test for the focused integration tests. Starting Hugo directly bypasses bibliography preparation; use the documented container commands for a complete site preview.