Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
KapilKhanal authored Jan 12, 2025
1 parent cac5283 commit a2f6fa6
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,13 @@ Fully-differentiable boundary element solver for marine hydrodynamics. This new
using Pkg
Pkg.activate(".")
Pkg.instantiate()
4. **Using the BEM Module**
```
4. **Configure PyCall**
```
ENV["PYTHON"] = "/path/to/capytaine_env/bin/python" # run 'which python' in your terminal for this
```
6. **Using the BEM Module**
Load the module in your Julia session:
```julia
using BEM
Expand All @@ -87,7 +93,7 @@ F = DiffractionForce(mesh,ω,ζ)
A,B = calculate_radiation_forces(mesh,ζ,ω)
```

5. **Differentiability** :
6. **Differentiability** :
For differentiability with respect to mesh dimension, use `paper/MeshGradients_singlebody.jl`
Differentiability needs an AD engine: use Zygote
```julia
Expand Down

0 comments on commit a2f6fa6

Please sign in to comment.