Skip to content

Commit fc53a80

Browse files
committed
Meshio optional dependency explained in Readme
1 parent 71aeecd commit fc53a80

3 files changed

Lines changed: 10 additions & 1 deletion

File tree

pysplashsurf/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,12 @@ pip install pysplashsurf
1010
```
1111
Requires Python version 3.7+
1212

13+
To install pysplashsurf directly with meshio (which allows some additional functionality), do
14+
```
15+
pip install pysplashsurf[meshio]
16+
```
17+
When meshio is installed, support for the `.bgeo` extension will be added to it, so that particle data from the `BGEOV` format can be read using meshio. Meshio is also required for the `write_to_file` method to work. The rest of the package will still work even if meshio is not installed.
18+
1319
## Usage
1420
Example to reconstruct the surface from an input file, apply some post processing methods and write the data back to a file:
1521
```python

pysplashsurf/pysplashsurf/docs/source/api.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ Methods
2020
par_laplacian_smoothing_normals_inplace
2121
reconstruct_surface
2222
reconstruction_pipeline
23+
write_to_file
2324

2425
Classes
2526
-------

pysplashsurf/pysplashsurf/docs/source/methods.rst

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,6 @@ All methods infer float precision based on the input (32bit or 64bit).
2929

3030
.. autofunction:: reconstruct_surface
3131

32-
.. autofunction:: reconstruction_pipeline
32+
.. autofunction:: reconstruction_pipeline
33+
34+
.. autofunction:: write_to_file

0 commit comments

Comments
 (0)