From 56dd88dacd3d220b436c8f687ca1fcaf73fdef5e Mon Sep 17 00:00:00 2001 From: Matt McKay Date: Thu, 1 Oct 2026 15:32:24 +1000 Subject: [PATCH] Update the landing page: buffer-stock saving, model descriptions, the name The library table gains buffer-stock saving as its first row, with HARK's solution (in review in #5) in its first slot and its description marked as a draft; the four proposed families are marked "description (planned)". #5 replaced the template notebook with a shared model description, so section 04 becomes "Model descriptions" and the remaining mentions of templates follow. QuantEcon's role now reads "develops shared tooling in consultation with the projects", linking its infrastructure page, and the AI advisor moves from Phase 1 to Phase 2 as something to explore. The footer and README use the group's settled name, Language and Semantics; the footer links the working group's code of conduct; and the README's entry for the Project B talk no longer points to its source. Co-Authored-By: Claude Opus 5.5 --- README.md | 11 ++++---- docs/index.html | 67 +++++++++++++++++++++++++++++-------------------- docs/site.css | 12 ++++++++- 3 files changed, 57 insertions(+), 33 deletions(-) diff --git a/README.md b/README.md index 84caf0e..39099e3 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,18 @@ The Community Library is an open-source library of baseline models in computatio For each model the library documents the model statement and the calibration, so that implementations in different toolkits can be compared side by side. Each implementation is authored and maintained by the project that built the toolkit and is open to review by the community. -The library is hosted by QuantEcon and published at ****. It is run in collaboration with the [SCE Working Group 1 on Language and Formal Semantics](https://github.com/econ-ark/sce-wg-1). +The library is hosted by QuantEcon and published at ****. It is run in collaboration with the [SCE Working Group 1 on Language and Semantics](https://github.com/econ-ark/sce-wg-1). This repository holds the community website and the notebooks submitted by participating projects. ## How it works -The working group provides a set of baseline models. Each participating project chooses as many as its toolkit can solve — several or just one — and completes the model's template notebook in its own toolkit: the code, plus commentary where its method differs. The completed notebook is its tutorial. Baseline templates (a PDF and a notebook per model, with the model statement and explanatory text already written) are distributed from the working group website. +The working group provides a set of baseline models. Each participating project chooses as many as its toolkit can solve — several or just one — and writes its solution in its own toolkit and format: the code, plus commentary where its method differs. That notebook is its tutorial. Each model has a shared model description, published as a page and a PDF, that pins the model, its calibration and what each solution reports, and leaves the method to the project. -Four models seed the set: +Buffer-stock saving comes first; four more are proposed: | Baseline model | Model class | | --- | --- | +| Buffer-stock saving | Consumption–saving under income risk | | Aiyagari · Krusell–Smith | Incomplete-markets heterogeneous agents | | A two-asset HANK model | Heterogeneous-agent New Keynesian | | A small New Keynesian DSGE model | Representative-agent DSGE | @@ -29,7 +30,7 @@ Four models seed the set: | `docs/index.html` | the page | | `docs/site.css` | design tokens and components | | `docs/site.js` | contents-rail scrollspy | -| `docs/sce-wg1-2026-10-01.html` | the Project B talk to SCE Working Group 1 (1 October 2026): a self-contained reveal.js deck, rendered from its Quarto source in `presentations/2026-10-01-sce-wg1-community-library/` of QuantEcon/project-community-library | +| `docs/sce-wg1-2026-10-01.html` | the Project B talk to SCE Working Group 1 (1 October 2026), a self-contained reveal.js deck | | `docs/assets/` | images | `.github/workflows/publish.yml` checks the site on every push and pull request — local references resolve, in-page anchors resolve, and the contents rail is still wired to its sections — then deploys `docs/` to GitHub Pages from `main`. Pull requests get the same checks plus the built site as a downloadable artifact, so a change can be reviewed rendered. @@ -38,7 +39,7 @@ Publishing requires **Settings → Pages → Build and deployment → Source: Gi ## Status -The repository structure, contribution guidelines, and the first baseline templates are in preparation. Until then, discussion happens in the [working group issue tracker](https://github.com/econ-ark/sce-wg-1/issues). +The repository structure, contribution guidelines, and the first model descriptions are in preparation; the buffer-stock saving description and a HARK solution are in review in #5. Until then, discussion happens in the [working group issue tracker](https://github.com/econ-ark/sce-wg-1/issues). ## Licensing diff --git a/docs/index.html b/docs/index.html index c30fd9a..60972b8 100644 --- a/docs/index.html +++ b/docs/index.html @@ -63,7 +63,7 @@

Hosted by QuantEcon

Working alongside
    -
  • SCE Working Group 1 — publishes the baseline set and templates.
    • +
  • SCE Working Group 1 — publishes the baseline set and its model descriptions.
@@ -100,7 +100,7 @@

Hosted by QuantEcon

  • 01Why
  • 02The library
  • 03How it works
    • -
  • 04Templates
    • +
  • 04Descriptions
  • 05The ask
  • 06Who does what
  • 07Roadmap
    • @@ -154,12 +154,25 @@

    Community first, corpus second

    02

    The library

    -

    The working group publishes a set of baseline models. Each project chooses as many as its toolkit can solve — several or just one — and submits a tutorial for each. Four models seed the set.

    +

    The working group publishes a set of baseline models. Each project chooses as many as its toolkit can solve — several or just one — and submits a tutorial for each. Buffer-stock saving comes first; four more are proposed.

    Baseline set · v0 proposal - Implementations · template + Implementations · description +
    + +
    +
    +

    Buffer-stock saving

    +

    Consumption–saving under income risk

    +
    +
    + HARK · in review + open + open +
    +
    description ⟨draft⟩
    @@ -172,7 +185,7 @@

    Aiyagari · Krusell–Smith

    open open
    -
    template ⟨draft⟩
    +
    description ⟨planned⟩
    @@ -185,7 +198,7 @@

    A two-asset HANK model

    open open
    -
    template ⟨draft⟩
    +
    description ⟨planned⟩
    @@ -198,7 +211,7 @@

    A small New Keynesian DSGE model

    open open
    -
    template ⟨draft⟩
    +
    description ⟨planned⟩
    @@ -211,7 +224,7 @@

    A baseline agent-based macro model

    open open
    -
    template ⟨draft⟩
    +
    description ⟨planned⟩
    @@ -219,7 +232,7 @@

    A baseline agent-based macro model

    open an issue ↗     -

    Open slots fill as projects join — one per participating toolkit. A model earns its place in the set by being solved; each row's template pins what has to line up.

    +

    Open slots fill as projects join — one per participating toolkit. A model earns its place in the set by being solved; each row's description pins what has to line up.

    @@ -243,12 +256,12 @@

    An author's-choice showcase

    Both are published in the toolkit's own notation — no house dialect — with per-model metadata, honest notes on tradeoffs, and CI that runs each implementation and flags breakage.

    -
    +
    04 -

    Baseline templates

    +

    Model descriptions

    -

    Each model in the set gets a baseline template: a precise statement of what the model is — enough that results line up across toolkits — without prescribing how it should be solved.

    +

    Each model in the set gets a model description: a precise statement of what the model is — enough that results line up across toolkits — without prescribing how it should be solved.

    @@ -263,19 +276,19 @@

    Projects choose models

    03 -

    A template notebook each

    -

    Published as a PDF and a notebook, model statement and explanatory text already written.

    +

    A description each

    +

    Published as a page and a PDF: the model, its calibration, and what each solution reports.

    04

    Implementations line up

    -

    Each project completes the notebook in its own toolkit — and that notebook is its tutorial.

    +

    Each project writes its solution in its own toolkit and format — and that notebook is its tutorial.

    - The template pins + The description pins
    • Functional forms, timing conventions, normalizations
    • Parameter values, and where they come from
      • @@ -285,7 +298,7 @@

      Implementations line up

    - The template leaves free + The description leaves free
    • Solution method and algorithm
    • Grids, discretization, basis functions
      • @@ -296,7 +309,7 @@

      Implementations line up

    -

    Divergence beyond tolerance is documented and attributed to method — a result of the exercise, not a failure of it. A project that cannot match one element of a template contributes with a documented deviation rather than dropping out. Phase 1 publishes no timings and no ranking of toolkits.

    +

    Divergence beyond tolerance is documented and attributed to method — a result of the exercise, not a failure of it. A project that cannot match one element of a description contributes with a documented deviation rather than dropping out. Phase 1 publishes no timings and no ranking of toolkits.

    @@ -309,7 +322,7 @@

    The ask

    What each project provides

    • Agreement in principle to take part.
      • -
    • By end of 2026, at least one baseline model solved against its template, so results line up side by side.
      • +
    • By end of 2026, at least one baseline model solved against its description, so results line up side by side.
    • An author's-choice showcase tutorial highlighting where the toolkit is strongest.
    • Both contributions authored and maintained by the project — CC-BY for text, an OSI-approved licence for code.
    @@ -335,7 +348,7 @@

    Who does what

    Host

    QuantEcon

    -

    Publishes and maintains the library, sets editorial standards for what goes in, and builds the shared tooling: local-run handlers for MATLAB, Octave and Julia, schema validators, converters between output formats.

    +

    Publishes and maintains the library, sets editorial standards for what goes in, and develops shared tooling in consultation with the projects, as part of QuantEcon's open-source infrastructure.

    Authors @@ -345,7 +358,7 @@

    Participating projects

    Baseline set

    SCE Working Group 1

    -

    Builds and releases the baseline set and templates. The library is run in collaboration with the group; QuantEcon attends as a member to see where it can assist the group's semantics work.

    +

    Builds and releases the baseline set and its model descriptions. The library is run in collaboration with the group; QuantEcon attends as a member to see where it can assist the group's semantics work.

    Semantics @@ -371,7 +384,6 @@

    Phase 1 · Community library

  • Open-source repository, PRs welcome.
  • Per-project tutorials and per-model metadata.
  • CI runs the implementations and flags breakage.
    • -
  • An AI advisor MVP built on the corpus.
    • @@ -384,6 +396,7 @@

    Phase 2 · Reference standard

  • Cross-toolkit validation reports: where do the same model's outputs diverge?
  • Library models expressed in a shared semantic representation, building on Econ-ARK's DP schema.
  • Documentation of that design, plus a how-to tutorial.
    • +
  • Exploring an AI advisor built on the corpus.
    • @@ -425,8 +438,8 @@

    Contribute

    - Templates -

    Distributed from this site — a PDF and a notebook per baseline model, versioned and credited to their author.

    + Model descriptions +

    Published with the library — a page and a PDF per baseline model, versioned and credited to their authors.

    Licensing @@ -434,7 +447,7 @@

    Contribute

    Discussion -

    Open questions on templates and the baseline set are settled in the working group issue tracker.

    +

    Open questions on model descriptions and the baseline set are settled in the working group issue tracker.

    @@ -467,10 +480,10 @@

    Bring your toolkit into the library.

  • Repository
  • SCE WG1
  • CEF 2026
    • -
  • Code of conduct ⟨tbd⟩
    • +
  • Code of conduct
    • -

    The Community Library is hosted by QuantEcon. It is run in collaboration with SCE Working Group 1 on Language and Formal Semantics, which publishes the baseline set and templates and leads the semantics track alongside Econ-ARK.

    +

    The Community Library is hosted by QuantEcon. It is run in collaboration with SCE Working Group 1 on Language and Semantics, which publishes the baseline set and its model descriptions and leads the semantics track alongside Econ-ARK.

    © 2026 QuantEcon · CC-BY on text, OSI-approved licences on code

    diff --git a/docs/site.css b/docs/site.css index 67d035f..99c64b5 100644 --- a/docs/site.css +++ b/docs/site.css @@ -495,8 +495,18 @@ a:hover { color: var(--qe-blue-dark); text-decoration: underline; } color: #999; } +/* A slot a project has filled: solid where the open ones are dashed, and a + link to the solution or the pull request that adds it. */ +.slot.is-filled { + border-style: solid; + border-color: var(--qe-blue); + color: var(--qe-blue); +} +a.slot.is-filled:visited { color: var(--qe-blue); } +a.slot.is-filled:hover { background: var(--qe-blue); color: #fff; text-decoration: none; } + .model-template { - flex: 0 0 118px; + flex: 0 0 170px; text-align: right; font-family: var(--mono); font-size: .72rem;