basilisk-C

Quick Start (Ref-Locked Installation)

First-time install (or reinstall):

curl -sL https://raw.githubusercontent.com/comphy-lab/basilisk-C/main/reset_install_basilisk-ref-locked.sh | bash -s -- --ref=v2026-01-13 --hard

Subsequent runs (reuses existing basilisk/ if same ref):

curl -sL https://raw.githubusercontent.com/comphy-lab/basilisk-C/main/reset_install_basilisk-ref-locked.sh | bash -s -- --ref=v2026-01-13

Note: Replace v2026-01-13 with the latest release tag.

About This Fork

This repository contains our fork of the Basilisk C codebase (basilisk.fr). We maintain this fork to track and document comphy-lab related bugs and issues. This is a development fork that will be frequently synced with the main Basilisk repository.

Repository Structure

This repository is organized with two main Darcs repositories:

• basilisk-source/: Contains the source code for Basilisk C
• basilisk-wiki/: Contains the documentation and wiki content

Each directory is synchronized daily with the corresponding Darcs repository from basilisk.fr.

About Basilisk C

Basilisk C is a powerful open-source computational fluid dynamics (CFD) framework that provides:

• A complete environment for solving partial differential equations on adaptive Cartesian meshes
• Built-in support for multiphase flows, surface tension, and complex geometries
• High-performance parallel computing capabilities
• Advanced visualization tools with interactive 3D display
• Memory profiling and debugging capabilities
• Python integration through SWIG

Acknowledgements

• S. Popinet & collaborators, Basilisk C, http://basilisk.fr (Last accessed: June 2025) (2013-2025)

Key Features

• Adaptive Mesh Refinement: Efficient handling of complex geometries and flow features
• Multiphase Flows: Built-in support for interface tracking and surface tension
• Parallel Computing: Scalable performance for large-scale simulations
• Interactive Visualization: Real-time 3D visualization using WebGL
• Memory Management: Built-in memory tracing and profiling tools
• Extensible Architecture: Modular design allowing easy addition of new physical models
• Local Visualization Server: Offline 3D visualization using a local bview client (manual URL works without patches; optional --local-bview installer flag enables bview --local convenience output — see Tips.md)

Getting Started

For installation and usage instructions, please refer to the installation guide and tutorial in the respective directories.

For our course on this codebase, please refer to our course website.

Documentation

Comprehensive documentation is available in the basilisk-wiki directory and at basilisk.fr, including:

• Tutorial examples
• User guides
• Technical documentation

Tips and Troubleshooting

For tips on installing Darcs and resolving common issues, please refer to our Tips.md file.

Reporting Issues

We use GitHub Issues to track bugs, installation problems, and feature requests. Please use the appropriate template when creating a new issue:

• Report a Bug
• Report an Installation Issue
• Request a Feature
• Report a Generic Issue
• To discuss with the Basilisk C community, please join the Google group.

Contributing

While this is a fork maintained for tracking specific issues, we welcome contributions that help improve the codebase. Please ensure your contributions align with the main Basilisk project's coding standards and practices.