Skip to content

Welcome to Kamayan

A kamayan is a Filipino cultural practice where a feast is shared communally, spread on top of a table, with diners eating with their hands, unhindered by the formalities often associated with western dining etiquette. The kamayan here aims to follow in that tradition as a hydrodynamics code, easing the combination of novel numerical methods with multi-physics applications.

Highlights

  • Built on the Parthenon Adaptive Mesh Refinement(AMR) framework for performance portability.
  • python bindings for quick simulation setup and initialization
  • Composable modular physics/infrastructure units to do almost anything

Quick Start

Get up and running with kamayan in minutes:

# Install UV package manager
curl -LsSf https://astral.sh/uv/install.sh | sh

# Get kamayan and its dependencies
git clone https://github.com/acreyes/kamayan.git
cd kamayan
git submodule update --init --recursive

# Build kamayan
mkdir build && cd build
uv run cmake ..
uv run cmake --build . -j4

# Run an example simulation
mpirun -np 4 isentropic_vortex -i ../src/problems/isentropic_vortex.in

For detailed build instructions, configuration options, and troubleshooting, see the Building guide.