Skip to content

Repository files navigation

title Michelin Star Per-Capita Dashboard
emoji 🍳
colorFrom yellow
colorTo blue
sdk static
pinned false

Michelin Star Per-Capita Dashboard

Verify Status Hugging Face Space ORCID License: MIT Python Version

A static Observable dashboard for gastronomy data analysis that visualizes aggregate Michelin Guide-style indicators alongside population, GDP, and geographic context.

Live Demo: Hugging Face Spaces
Repository: edithatogo/michelin-nz


⚖️ Data Ownership & Citation

Important

Data Ownership Disclaimer: Michelin Guide names, distinctions, ratings, text, branding, and related database rights are owned by Manufacture Française des Pneumatiques Michelin (Michelin Group) or its licensors. This repository's MIT license applies to the dashboard code only; it does not license Michelin-derived data. The public dashboard redistributes aggregate metrics and derived analysis only, not individual Michelin-derived rows, reviews, coordinates, or a guide-like database.

World Bank indicators are reused from World Bank Open Data and require source attribution under the World Bank dataset terms.

To cite this repository in academic or journalistic publications, please refer to CITATION.cff or use:

@software{michelin_nz_dashboard_2026,
  author = {Mordaunt, Dylan A},
  title = {Michelin Star Per-Capita Dashboard},
  url = {https://github.com/edithatogo/michelin-nz},
  year = {2026}
}

🗄️ Zenodo Archive Linkage

No Zenodo DOI has been minted yet. The repository includes .zenodo.json metadata so Zenodo can create a DOI after the GitHub integration is enabled. The scheduled external deployment workflow treats Zenodo as a strict gate, so it will fail until that DOI-bearing record exists.

To activate permanent DOI minting for releases:

  1. Log into your account on Zenodo using your GitHub credentials.
  2. Go to your GitHub Settings panel on Zenodo and toggle the switch for edithatogo/michelin-nz to On.
  3. Create a new GitHub Release/Tag. Zenodo will automatically mint a permanent DOI using the metadata in .zenodo.json.
  4. Replace this note with the minted DOI badge/link after Zenodo publishes the record.

See Release Checklist before publishing DOI-bearing releases.


🚀 Architecture & Tech Stack

  • Core Engine: Observable Framework - Static site generator optimized for data-dense dashboards.
  • Visualization: Observable Plot renders deterministic SVG charts that are covered by headless deployment smoke tests.
  • Build-Time Data Pipeline: Python loaders compile aggregate gastronomy indicators, World Bank demographics, and GDP indicators into JSON and Parquet assets at build time.
  • Interactive Analysis: Observable Inputs provide country filters, measure selectors, aggregation controls, and data tables.

🛠️ Installation & Local Development

  1. Clone the repository:

    git clone https://github.com/edithatogo/michelin-nz.git
    cd michelin-nz
  2. Install Pixi:

    curl -fsSL https://pixi.sh/install.sh | bash
  3. Install Node Packages:

    npm install
  4. Run Strict Local Gates:

    pixi run python --version
    pixi run mojo-version
    pixi run format-check
    pixi run lint
    pixi run typecheck
    pixi run pytest --cov=src/data --cov-fail-under=85
    npm run lint
    npm run format:check
    npm run audit
  5. Run Local Dev Server:

    npm run dev

    Open http://localhost:3000 to preview the dashboard.


📂 Project Structure

  • src/ - Observable Framework markdown and styles.
  • src/data/ - Build-time aggregate metric loaders and Mojo-derived metric code (michelin.parquet.sh, michelin.py, metrics.mojo).
  • conductor/ - Conductor project setup, specs, and workflow guidelines.

🤝 How to Contribute

We welcome community contributions for methodology, aggregate source documentation, and dashboard improvements. Do not submit individual Michelin-derived restaurant listings, guide text, reviews, photos, or proprietary metadata.


📄 License & Citation

This project's source code is licensed under the MIT License. See LICENSE for details. Third-party data, names, marks, and ratings remain subject to their original owners' terms.

To cite this project, please refer to CITATION.cff.

About

Observable dashboard for aggregate gastronomy indicators, population, and GDP analysis.

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages