# Examples

Here are some example projects that use Calkit.
If you have one you'd like to be included, please
[✏️ edit this page](https://github.com/calkit/calkit/edit/main/docs/examples.md).

## NACA 0012 2-D RANS with OpenFOAM

[Project page](https://calkit.io/petebachant/nacafoil-openfoam) |
[GitHub repo](https://github.com/petebachant/NACAFoil-OpenFOAM)

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](https://calkit.io/calkit/example-basic) |
[GitHub repo](https://github.com/calkit/example-basic)

Features:

- An automatically-managed Conda 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

## MATLAB

[Project page](https://calkit.io/calkit/example-matlab) |
[GitHub repo](https://github.com/calkit/example-matlab)

Features:

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

## Strava analysis

[Project page](https://calkit.io/petebachant/strava-analysis) |
[GitHub repo](https://github.com/petebachant/strava-analysis)

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](https://calkit.io/petebachant/rans-boundary-layer-validation) |
[GitHub repo](https://github.com/petebachant/rans-boundary-layer-validation)

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](https://calkit.io/calkit/example-ssh) |
[GitHub repo](https://github.com/calkit/example-ssh)

Features:

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

## Overleaf integration

[Project page](https://calkit.io/calkit/example-overleaf) |
[GitHub repo](https://github.com/calkit/example-overleaf)

Features:

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