Skip to content

Commit 0ccdbae

Browse files
committed
Add visualize module; update README
1 parent 62392bb commit 0ccdbae

File tree

2 files changed

+2190
-2
lines changed

2 files changed

+2190
-2
lines changed

README.md

Lines changed: 28 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ PyniteFEA is excellent and it is generally design-ready. The functions in this p
66

77
Modules included:
88

9+
- `visualize`: Plot your `FEModel3D` using plotly
910
- `reports`: Quickly export node and member results in structured dictionaries (previously in the `pynite_reporting` package)
1011
- `serialize`: Export and import `FEModel3D` objects to JSON
1112
- `combos`: Convenience function for bulk-adding load combinations to `FEModel3D` objects
@@ -19,17 +20,42 @@ pip install pynite-tools
1920

2021
## Dependencies
2122

23+
- Python >= 3.11
2224
- `PyniteFEA` >= 1.1.0
2325
- `numpy` >= 2.0.0
2426
- `deepmerge` >= 2.0.0
2527
- `pydantic` >= 2.0.0
2628

2729

30+
## Examples: `visualize`
31+
32+
```python
33+
from Pynite import FEModel3D
34+
import pynite_tools.visualize as pv
35+
36+
model = FEModel3D(...) # Build your model
37+
38+
# pv.plot_model is the "express" function
39+
pv.plot_model(model, combo_name="LC1")
40+
41+
# pv.Renderer is a class that gives you detailed control of the plot
42+
model_renderer = pv.Renderer(model, combo_name="LC1")
43+
44+
## For example...
45+
model_renderer.annotation_size = 5
46+
model_renderer.window_width = 1200
47+
model_renderer.window_height = 1000
48+
49+
## Now render the model
50+
model_renderer.render_model()
51+
```
52+
53+
2854
## Examples: `reports`
2955

3056
```python
3157
from Pynite import FEModel3D
32-
from pynite_tools import reports as pr
58+
import pynite_tools.reporting as pr
3359

3460
model = FEModel3D(...) # Build your model here
3561

@@ -105,7 +131,7 @@ forces_at_location_ratios = pr.extract_member_actions_by_location(
105131
)
106132

107133
# Merge result trees into a single tree for serializing to JSON
108-
merged_tree = pr.merge_trees([force_arrays, forces_minmax, forces_at_locations])
134+
merged_tree = pr.merge_result_trees([force_arrays, forces_minmax, forces_at_locations])
109135
```
110136

111137
## Examples: `serialize`

0 commit comments

Comments
 (0)