PhiFlow
PlaygroundDocumentation
- Installation Instructions: Requirements, installation, CUDA compilation
- Contributing to ΦFlow: Style guide, docstrings, commit tags
- Cookbook: Example code snippets for various things
- What to Avoid: How to keep your code compatible with PyTorch, TensorFlow and Jax
| Module API | Documentation |
|---|---|
| phi.vis | Visualization: Plotting, interactive user interfaces Dash: Web interface Widgets: Notebook interface Console: Command line interface |
| phi.physics phi.physics.advect phi.physics.fluid phi.physics.diffuse phi.physics.flip |
Fluids Tutorial: Introduction to core classes and fluid-related functions. Overview: Domains, built-in physics functions Functions for Fluid Simulations: Advection, projection, diffusion |
| phi.field | ▶️ Introduction Video Overview: Grids, particles Staggered Grids: Data layout, usage Reading and Writing Simulation Data Scene Format Specification: Directory layout, file format |
| phi.geom | Overview: Differentiable Geometry |
| phi.math phi.math.backend phi.math.extrapolation |
▶️ Introduction Video Overview: Named dimensions, backends, indexing, non-uniform tensors, precision Optimization and Training: Automatic differentiation, neural network training Performance: GPU, JIT compilation, profiler |
Core Classes
API Documentation
The API documentation is generated using pdoc3. To manually generate the documentation, add the PhiFlow directory to your Python path and run
$ pdoc --html --output-dir docs --force phi
This requires PyTorch, TensorFlow and Jax to be installed, in addition to the standard ΦFlow requirements.