Skip to content

Commit 029ef71

Browse files
TimoLinxiao312
andauthored
Update README for v2.0 update (#581)
* Fix errors in createLocalBlend. * Update dfode-kit and agents description. * Add DFODE-kit tutorial instruction in the documentation. * Update link to DFODE-kit agent tutorial * Update DFODE-kit Trainer description * Enhance FlamePilot documentation with new features Updated the description of FlamePilot to highlight its features and capabilities as a CFD agent. Added an image and improved the introduction for clarity. * Update project repository link for FlamePilot * Update README with new features for v2.0 * Update README --------- Co-authored-by: xiao312 <xiaoxiao1642@163.com>
1 parent 028bc05 commit 029ef71

7 files changed

Lines changed: 45 additions & 9 deletions

File tree

README.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,25 @@
1919
</a>
2020
</p>
2121

22-
DeepFlame is a deep learning empowered computational fluid dynamics package for single or multiphase, laminar or turbulent, reacting flows at all speeds. It aims to provide an open-source platform to combine the individual strengths of [OpenFOAM](https://openfoam.org), [Cantera](https://cantera.org), and [PyTorch](https://pytorch.org/) libraries for deep learning assisted reacting flow simulations. It also has the scope to leverage the next-generation heterogenous supercomputing and AI acceleration infrastructures such as GPU and FPGA.
22+
DeepFlame is a deep learning empowered computational fluid dynamics package for single or multiphase, laminar or turbulent, reacting flows at all speeds. It aims to provide an open-source platform to combine the individual strengths of [OpenFOAM](https://openfoam.org), [Cantera](https://cantera.org), and [PyTorch](https://pytorch.org/) libraries for deep learning assisted reacting flow simulations. It also has the scope to empower the combustion community to pursue scientific innovation by combining the power of heterogeneous acceleration (GPU/FPGA) with autonomous agent-driven workflows.
2323

24-
The neural network models used in the tutorial examples can be found at– [AIS Square](https://www.aissquare.com/). To run DeepFlame with DNN, download the DNN model [DFODE](https://www.aissquare.com/models/detail?pageType=models&name=DF-ODENet_DNNmodel&id=197) into the case folder you would like to run.
24+
The neural network models used in the tutorial examples can be found at– [AIS Square](https://www.aissquare.com/). To run DeepFlame with DNN, download the DNN model [DFODE](https://www.aissquare.com/models/detail?pageType=models&name=DF-ODENet_DNNmodel&id=197) into the case folder you would like to run. To train DNN models for your specific problem, please use the [DFODE-kit](https://github.com/deepflame-ai/DFODE-kit) package developed by the DeepFlame team.
2525

2626
## Documentation
2727
Detailed guide for installation and tutorials is available on [our documentation website](https://deepflame.deepmodeling.com).
2828

2929
## Features
30+
New in v2.0 (2026/1/28):
31+
- Introduce Agent-driven Combustion Scientific Computing as a new research paradigm, extending DeepFlame from pure acceleration to workflow-level automation for CombustionCFD
32+
- Develope [FlamePilot](./agents/FlamePilot.md), a CFD simulation agent for combustion case setup, runtime diagnosis, and iterative optimization via natural language interaction
33+
- Introduce [DFODE-kit](https://github.com/deepflame-ai/DFODE-kit), a deep learning package for accelerating stiff, high-dimensional chemical kinetics ODEs
34+
- Develope [DFODE-Kit Trainer](./agents/DFODE-kit-Trainer.md), an agent-driven workflow for training combustion-chemistry neural-networks
35+
- Improve initialization in `dfChemistryModel`
36+
- Fix bug in `df0DFoam`
37+
- Fix bug in LES `SIGMA` sgs model
38+
- Add support for the localBlended scheme
39+
- Change build-test actions to self-hosted runner
40+
3041
New in v1.6 (2025/5/30):
3142
- Add a new solver, dfSteadyFoam, a steady-state compressible flow solver. It supports turbulence and uses the SIMPLE algorithm to efficiently compute steady solutions
3243
- Extend energy model to support sensible enthalpy (hs) in addition to absolute enthalpy (ha) and internal energy (ea). Furthermore, T, h and cp can now be computed independently of Cantera, improving flexibility and removing external dependencies. `CANTERA_THERMO` is added in bashrc to control method to calculate h, cp and update T. `CANTERA_THERMO=1`(current default) means using Cantera and `CANTERA_THERMO=0` means using deepflame.

agents/DFODE-kit-Trainer.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
DFODE-kit Trainer
2+
=================
3+
DFODE-kit Trainer is a specialized agent designed to facilitate the training of models using the DFODE-kit framework. This agent streamlines the process of setting up, executing, and monitoring training sessions for differential equation-based models. User can interact with the agent through natural language commands to configure the target case settings that the model will apply. The agent can recognize the requirements and automatically complete the data sampling, data enhancement and model training processes. Finally, it returns to the user a directly usable model and a clear task report.
4+
5+
To try DFODE-kit Trainer, visit [DFODE-kit agent tutorial](https://github.com/deepflame-ai/DFODE-kit/blob/agent/agent_user_guide_zh.md) for more details.

agents/FlamePilot.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
FlamePilot
2+
==========
3+
4+
<div align="center">
5+
<img src="https://github.com/xiao312/flamepilot-dev/raw/main/docs/assets/logo.png" alt="FlamePilot logo" width="640" />
6+
</div>
7+
8+
FlamePilot is an **agentic runner for combustion CFD workflows**, designed to automate and assist simulations within the DeepFlame ecosystem. It provides a **CLI-first, tool-aware agent** that translates natural language instructions into executable CFD actions, covering case setup, solver configuration, execution, diagnostics, and iteration.
9+
10+
FlamePilot emphasizes **executability and traceability**: it helps you go from intent → runnable case, while keeping workflows inspectable and compatible with research-grade CFD practices.
11+
12+
To try FlamePilot, visit the <a href="https://github.com/deepflame-ai/flamepilot">project repository</a>.

docs/source/citation.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,6 @@ Runze Mao, Minqi Lin, Yan Zhang, Tianhan Zhang, Zhi-Qin John Xu, Zhi X. Chen. De
88
**If you have used the DNN model provided from us, please use the citation:**
99

1010
Han Li, Ruixin Yang, Min Zhang, Runze Mao, Zhi X. Chen. A comprehensive study on the accuracy and generalization of deep learning-generated chemical ODE integrators. `arXiv:2312.16387 <https://arxiv.org/abs/2312.16387>`_
11+
12+
**If you have used the DFODE-kit package to train your own DNN models, please use the citation:**
13+
Han Li, Ke Xiao, Yangchen Xu, Haoze Zhang, Zhenyi Chen, Runze Mao, Zhi X. Chen. DFODE-Kit: Deep learning package for solving flame chemical kinetics with high-dimensional stiff ordinary differential equations. `doi.org/10.1016/j.cpc.2025.110013 <https://www.sciencedirect.com/science/article/abs/pii/S0010465525005144>`_

docs/source/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ The deep learning algorithms and models used in the DeepFlame tutorial examples
2525
:glob:
2626

2727
qs/install
28-
qs/download_dnn_models
28+
qs/dnn_models
2929
qs/examples
3030
qs/input
3131

docs/source/qs/dnn_models.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
DNN Models
2+
======================================
3+
4+
Download DNN Models
5+
--------------------------------------
6+
The neural network models used in the tutorial examples can be found at– `AIS Square <https://www.aissquare.com/>`_.
7+
To run DeepFlame with DNN, download the DNN model `dfODENet <https://www.aissquare.com/models/detail?pageType=models&name=dfODENet_DNNmodel_V0.1&id=181>`_ into the case folder you would like to run.
8+
9+
Train DNN models
10+
--------------------------------------
11+
If you would like to train your own models for your specific case, please use `DFODE-kit <https://github.com/deepflame-ai/DFODE-kit>`_ and check `tutorials <https://github.com/deepflame-ai/DFODE-kit/tree/main/tutorials>`_ for detailed instructions on how to develop and deploy your own neural network models.

docs/source/qs/download_dnn_models.rst

Lines changed: 0 additions & 6 deletions
This file was deleted.

0 commit comments

Comments
 (0)