Skip to content

Commit c026f6c

Browse files
committed
Sync readme and online index
1 parent e7d2de9 commit c026f6c

File tree

2 files changed

+7
-3
lines changed

2 files changed

+7
-3
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ See the [**Examples**](#examples) section below and the [**Tutorials**](tutorial
5353
**PyGeM** requires `numpy`, `scipy`, `matplotlib`, `sphinx` (for the
5454
documentation) and `nose` (for local test). They can be easily installed via
5555
`pip`. The code has been tested with Python3.7 version, but it should be
56-
compatible with Python3. The Python2 support is no longer maintained.
56+
compatible with a generic Python3.x. The Python2 support is no longer maintained.
5757
To enable the `CAD`
5858
[submodule](https://github.com/mathLab/PyGeM/tree/master/pygem/cad), the
5959
module `pythonocc-core` is required to deal with IGES files. This requirement

docs/source/index.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,18 @@ Description
1414

1515
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:
1616

17-
- Computer Aided Design files (in .iges and .stl formats)
18-
- Mesh files (in .unv and OpenFOAM formats)
17+
- Computer Aided Design files (in .iges, .step, and .stl formats)
18+
- Mesh files (in .unv, Elmer, and OpenFOAM formats)
1919
- Output files (in .vtk format)
2020
- LS-Dyna Keyword files (.k format)
2121

2222
By now, it has been used with meshes with up to 14 milions of cells. Try with more and more complicated input files!
23+
See the Tutorials section below to have an idea of the potential of this package.
2324

2425

2526
Installation
2627
^^^^^^^^^^^^
28+
The code has been tested with Python3.7 version, but it should be compatible with a generic Python3.x. The Python2 support is no longer maintained.
2729

2830
To install the pygem package, open the terminal/command line and clone the repository with the command
2931
::
@@ -39,6 +41,8 @@ After installing the dependencies you can navigate into the ``PyGeM`` folder (wh
3941
You should now be able to import the pygem library in Python scripts and interpreters with the command ``import pygem``.
4042

4143

44+
Alternatively, there is the possibility to get PyGeM through prebuilt and high-performance Docker images. Please, for the details, refer to the official `repository <https://github.com/mathLab/PyGeM>`_.
45+
4246

4347
Developer's Guide
4448
^^^^^^^^^^^^^^^^^^^^^^^

0 commit comments

Comments
 (0)