Skip to content

Examples

Here are some example projects that use Calkit. If you have one you'd like to be included, please ✏️ edit this page.

NACA 0012 2-D RANS with OpenFOAM

Project page | GitHub repo

Features:

  • A Docker environment for simulation
  • A uv venv environment
  • Interactive Plotly figures saved as JSON
  • Interactive HTML figures generated with PyVista
  • An interactive marimo app hosted on HF spaces for interacting with the results

A basic research project

Project page | GitHub repo

Features:

  • An automatically-managed uv virtual environment for data processing and visualization
  • A LaTeX publication built with a Docker container
  • A dev container spec to enable editing and collaboration with GitHub Codespaces

Runnable README

GitHub repo

Features:

  • A pipeline declared entirely in the README's code blocks, with Python, Julia, and R stages
  • Environments declared by the install commands the README shows
  • Output printed by each stage written back into the README

Create a copy with:

calkit new project my-readme \
    --from https://github.com/calkit/calkit/examples/markdown

See Runnable Markdown for how it works.

MATLAB

Project page | GitHub repo

Features:

  • Dependency checking before pipeline execution
  • MATLAB scripts run in batch mode

Julia

Project page | GitHub repo

Features:

  • A Julia environment declared with a Project.toml
  • A flow simulation script run with WaterLily.jl
  • A Jupyter notebook run in the same Julia environment
  • A LaTeX conference paper built with a Docker container from the script's figures

R

Project page | GitHub repo

Features:

  • An renv environment declared with a DESCRIPTION file
  • R scripts for analysis and plotting, with the processed data and figures versioned in Git

Analytics

Project page | GitHub repo

Features:

  • A Jupyter notebook as the whole pipeline, run in a uv environment
  • A dataset imported from Zenodo, with its license recorded
  • A notebook adapted from Kaggle, with its provenance and license recorded
  • Figures, tables, and results produced by the notebook and shown in the project showcase

Strava analysis

Project page | GitHub repo

Features:

  • OAuth2 authentication with an external API
  • Environmental variable dependencies
  • A pipeline designed to be run periodically to accumulate new data
  • A project showcase with interactive Plotly figures
  • A uv project-based environment and dedicated Python package

OpenFOAM RANS boundary later validation

Project page | GitHub repo

Features:

  • OpenFOAM simulations run in a Docker container
  • A LaTeX document built with a Docker container
  • A direct numerical simulation dataset for validation imported from a different project, derived from the Johns Hopkins Turbulence Database

SSH

Project page | GitHub repo

Features:

  • An SSH environment for running a remote command over SSH and copying back results to the local machine

Overleaf integration

Project page | GitHub repo

Features:

  • A publication linked to an Overleaf project, which syncs changes to the text from Overleaf, and pushes figures generated locally to Overleaf.

LaTeX with Word review

GitHub repo

Features:

  • A LaTeX paper split across multiple source files, built with a Docker container from a figure generated in a uv environment
  • A Word copy exported for reviewers, whose edits and comments merge back into the LaTeX source

Create a copy with:

calkit new project my-paper \
    --from https://github.com/calkit/calkit/examples/latex-word

See the LaTeX and Word tutorial for the workflow.