Skip to content

Commit 03144dc

Browse files
committed
readme: updated cases and references, added links
1 parent e28aaa9 commit 03144dc

File tree

1 file changed

+22
-6
lines changed

1 file changed

+22
-6
lines changed

README.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -43,12 +43,12 @@ In that case, the environment will just rely on the `done` signal to stop the ev
4343

4444
## CFD environments
4545

46-
| Environment | Description | Illustration |
47-
|:--------------|:---------------------------------------------------------------------------------------------------|:------------------------------------------------------------:|
48-
| `turek-v0` | A drag reduction problem exploiting two synthetic jets on a cylinder immersed in a flow at Re=100. | <img width="400" alt="gif" src="dragonfly/msc/turek.gif"> |
49-
| `shkadov-v0` | A control problem with multiple jets trying to damp instabilities on a falling liquid film. | <img width="400" alt="gif" src="dragonfly/msc/shkadov.gif"> |
50-
| `rayleigh-v0` | A control problem with local temperature control to kill a convection cell at Ra=1e4. | <img width="200" alt="gif" src="dragonfly/msc/rayleigh.gif"> |
51-
| `mixing-v0` | A problem where the agent must mix a scalar quantity by controlling the boundary velocities. | <img width="200" alt="gif" src="dragonfly/msc/mixing.gif"> |
46+
| Environment | Description | Illustration |
47+
|:--------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------:|
48+
| `turek-v0` | A drag reduction problem exploiting two synthetic jets on a cylinder immersed in a flow at Re=100. | <img width="400" alt="gif" src="dragonfly/msc/turek.gif"> |
49+
| `shkadov-v0` | A control problem with multiple jets trying to damp instabilities on a falling liquid film, from the <a href="https://github.com/jviquerat/beacon">beacon library</a>. Compatible with separability (see arxiv pre-print below). | <img width="400" alt="gif" src="dragonfly/msc/shkadov.gif"> |
50+
| `rayleigh-v0` | A control problem with local temperature control to kill a convection cell at Ra=1e4, from the <a href="https://github.com/jviquerat/beacon">beacon library</a>. | <img width="200" alt="gif" src="dragonfly/msc/rayleigh.gif"> |
51+
| `mixing-v0` | A problem where the agent must mix a scalar quantity by controlling the boundary velocities, from the <a href="https://github.com/jviquerat/beacon">beacon library</a>. | <img width="200" alt="gif" src="dragonfly/msc/mixing.gif"> |
5252

5353
## Mujoco environments
5454

@@ -67,3 +67,19 @@ In that case, the environment will just rely on the `done` signal to stop the ev
6767
| <img height="200" alt="gif" src="dragonfly/msc/lunarlander.gif"> | <img height="200" alt="gif" src="dragonfly/msc/bipedalwalker.gif"> | <img height="200" alt="gif" src="dragonfly/msc/mountaincar.gif"> |
6868
| **`CarRacing-v2`** | **`?`** | **`?`** |
6969
| <img height="200" alt="gif" src="dragonfly/msc/carracing.gif"> | | |
70+
71+
## Referencing
72+
73+
If you end up using this library for research purpose, please consider citing one of the following papers (<a href="https://arxiv.org/abs/2505.03778">link</a> and <a href="https://www.mdpi.com/2311-5521/8/7/208">link</a>):
74+
75+
```
76+
Dragonfly, a modular deep reinforcement learning library
77+
J. Viquerat, P. Garnier, A. Bateni, E. Hachem
78+
arXiv pre-print 2505.03778, 2025
79+
```
80+
81+
```
82+
Parallel bootstrap-based on-policy deep reinforcement learning for continuous fluid flow control applications
83+
J. Viquerat, E. Hachem
84+
Fluids, vol. 8, iss. 7, 2023
85+
```

0 commit comments

Comments
 (0)