Overview

intsharp is a modular, YAML-driven simulation framework to capture moving interfaces.

Quick Start

# Clone and install
git clone https://github.com/marzialetech/intsharp.git
cd intsharp
pip install -r requirements.txt

# Run a simulation
python run.py config.yaml

Project Structure

intsharp/
├── run.py              # CLI entry point
├── intsharp/
│   ├── config.py       # YAML parsing + Pydantic validation
│   ├── domain.py       # 1D grid setup
│   ├── fields.py       # Field containers + IC evaluation
│   ├── boundary.py     # Boundary conditions
│   ├── registry.py     # Decorator-based component registry
│   ├── runner.py       # Main simulation loop
│   ├── sharpening.py   # PM and CL sharpening
│   ├── timesteppers.py # Euler and RK4
│   ├── solvers/
│   │   └── upwind.py   # First-order upwind
│   └── monitors/
│       ├── console.py  # Progress bar
│       ├── image.py    # PNG/PDF output
│       ├── gif.py      # Animated GIF
│       ├── hdf5.py     # HDF5 data
│       ├── txt.py      # Columnar text
│       └── curve.py    # Curve format
└── unit_tests/         # Validation cases

Cite intsharp

BibTeX for citing the intsharp documentation and software:

@misc{marziale2026intsharp,
  author       = {Marziale, Joseph J},
  title        = {intsharp Webpage},
  year         = {2026},
  howpublished = {\url{https://intsharp.marziale.tech}}
}