You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,12 @@ Python Geometrical Morphing.
5
5
6
6
7
7
## Description
8
-
**PyGeM** is a python library using **Free Form Deformation** and **Radial Basis Functions** to parametrize and morph complex geometries. It is ideally suited for actual industrial problems, since it allows to handle:
8
+
**PyGeM** is a python library using **Free Form Deformation**, **Radial Basis Functions** and **Inverse Distance Weighting** to parametrize and morph complex geometries. It is ideally suited for actual industrial problems, since it allows to handle:
9
9
10
10
- Computer Aided Design files (in .iges and .stl formats)
11
11
- Mesh files (in .unv and OpenFOAM formats)
12
12
- Output files (in .vtk format)
13
+
- LS-Dyna Keyword files (.k format)
13
14
14
15
By now, it has been used with meshes with up to 14 milions of cells. Try with more and more complicated input files!
15
16
See the **Examples** section below to have an idea of the potential of this package.
@@ -30,7 +31,7 @@ Pick the geometry, the parameters file, set the name of the output and decide wh
30
31
31
32
## Dependencies and installation
32
33
**PyGeM** requires `numpy`, `numpy-stl`, `scipy` and `matplotlib`. They can be easily installed via `pip`.
33
-
Moreover **PyGeM** depends on `OCC`>= 0.16 and `vtk`. These requirements cannot be satisfied through `pip`.
34
+
Moreover **PyGeM** depends on `OCC` and `vtk`. These requirements cannot be satisfied through `pip`.
34
35
Please see the table below for instructions on how to satisfy the requirements.
35
36
36
37
| Package | Version | Comment |
@@ -87,7 +88,7 @@ To allow the X11 forwarding in the container, on Linux system just run:
87
88
For Windows system, you need to install Cygwin/X version and running the command in Cygwin terminal. While for mac system, you need to install xquartz.
88
89
89
90
## Documentation
90
-
**PyGeM** uses [Sphinx](http://www.sphinx-doc.org/en/stable/) for code documentation. To build the html versions of the docs simply:
91
+
**PyGeM** uses [Sphinx](http://www.sphinx-doc.org/en/stable/) for code documentation. You can view the documentation online [here](http://mathlab.github.io/PyGeM/). To build the html versions of the docs locally simply:
91
92
92
93
```bash
93
94
>cd docs
@@ -109,12 +110,12 @@ To run tests locally:
109
110
110
111
## Authors and contributors
111
112
**PyGeM** is currently developed and mantained at [SISSA mathLab](http://mathlab.sissa.it/) by
under the supervision of [Prof. Gianluigi Rozza](mailto:[email protected]).
116
+
under the supervision of [Prof. Gianluigi Rozza](mailto:[email protected]). We thank [Filippo Salmoiraghi](mailto:[email protected]) for the original idea behind this package and the major contributions.
116
117
117
-
Contact us by email for further information or questions about **PyGeM**, or suggest pull requests. **PyGeM** is at an early development stage, so contributions improving either the code or the documentation are welcome!
118
+
Contact us by email for further information or questions about **PyGeM**, or suggest pull requests. Contributions improving either the code or the documentation are welcome!
Copy file name to clipboardExpand all lines: docs/source/index.rst
+2-1Lines changed: 2 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,11 +12,12 @@ Python utilities for geometrical morphing.
12
12
Description
13
13
^^^^^^^^^^^^
14
14
15
-
PyGeM is a python library using Free Form Deformation and Radial Basis Functions to parametrize and morph complex geometries. It is ideally suited for actual industrial problems, since it allows to handle:
15
+
PyGeM is a python library using Free Form Deformation, Radial Basis Functions and Inverse Distance Weighting to parametrize and morph complex geometries. It is ideally suited for actual industrial problems, since it allows to handle:
16
16
17
17
- Computer Aided Design files (in .iges and .stl formats)
18
18
- Mesh files (in .unv and OpenFOAM formats)
19
19
- Output files (in .vtk format)
20
+
- LS-Dyna Keyword files (.k format)
20
21
21
22
By now, it has been used with meshes with up to 14 milions of cells. Try with more and more complicated input files!
0 commit comments