Skip to content

Latest commit

 

History

History
154 lines (108 loc) · 6.67 KB

README.md

File metadata and controls

154 lines (108 loc) · 6.67 KB
Raw

PyGeM Build Status Coverage Status Code Issues

Python Geometrical Morphing.

Python Geometrical Morphing

Description

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:

  • Computer Aided Design files (in .iges and .stl formats)
  • Mesh files (in .unv and OpenFOAM formats)
  • Output files (in .vtk format)

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

Graphic Unit Interface

PyGeM is now provided with a very basic Graphic Unit Interface (GUI) that, in Ubuntu environment, looks like the one depicted below. This feature can be easily used even by the pythonists beginners with not much effort. Up to now, PyGeM GUI works on linux and Mac OS X computers.

Pick the geometry, the parameters file, set the name of the output and decide whether dump the FFD lattices or not. Now just click on the Run PyGeM button and that is it.

PyGeM GUI: how it appears when it pops up.

Dependencies and installation

PyGeM requires numpy, numpy-stl, scipy and matplotlib. They can be easily installed via pip. Moreover PyGeM depends on OCC >= 0.16 and vtk. These requirements cannot be satisfied through pip. Please see the table below for instructions on how to satisfy the requirements.

Package Version Comment
OCC >= 0.16 See pythonocc.org or github.com.tpaviot/pythonocc-core for instructions or conda install -c https://conda.anaconda.org/dlr-sc pythonocc-core
vtk >= 5.0 Simplest solution is conda install vtk

The official distribution is on GitHub, and you can clone the repository using

> git clone https://github.com/mathLab/PyGeM

To install the package just type:

> python setup.py install

To uninstall the package you have to rerun the installation and record the installed files in order to remove them:

> python setup.py install --record installed_files.txt
> cat installed_files.txt | xargs rm -rf

Documentation

PyGeM uses Sphinx for code documentation. To build the html versions of the docs simply:

> cd docs
> make html

The generated html can be found in docs/build/html. Open up the index.html you find there to browse.

Testing

We are using Travis CI for continuous intergration testing. You can check out the current status here.

To run tests locally:

> python test.py

Authors and contributors

PyGeM is currently developed and mantained at SISSA mathLab by

under the supervision of Prof. Gianluigi Rozza.

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!

Examples

You can find useful tutorials on how to use the package in the tutorials folder. Here we show two applications, taken from the naval and automotive engineering fields. On the other hand, the provided tutorials are related to easier geometries.

DTMB-5415 hull: morphing of the bulbous bow starting from an industrial .iges CAD file.

DrivAer model: morphing of the bumper starting from an OpenFOAM mesh file.

How to contribute

We'd love to accept your patches and contributions to this project. There are just a few small guidelines you need to follow.

Submitting a patch

  1. It's generally best to start by opening a new issue describing the bug or feature you're intending to fix. Even if you think it's relatively minor, it's helpful to know what people are working on. Mention in the initial issue that you are planning to work on that bug or feature so that it can be assigned to you.

  2. Follow the normal process of forking the project, and setup a new branch to work in. It's important that each group of changes be done in separate branches in order to ensure that a pull request only includes the commits related to that bug or feature.

  3. To ensure properly formatted code, please make sure to use a tab of 4 spaces to indent the code. You should also run pylint over your code. It's not strictly necessary that your code be completely "lint-free", but this will help you find common style issues.

  4. Any significant changes should almost always be accompanied by tests. The project already has good test coverage, so look at some of the existing tests if you're unsure how to go about it. We're using coveralls that is an invaluable tools for seeing which parts of your code aren't being exercised by your tests.

  5. Do your best to have well-formed commit messages for each change. This provides consistency throughout the project, and ensures that commit messages are able to be formatted properly by various git tools.

  6. Finally, push the commits to your fork and submit a pull request. Please, remember to rebase properly in order to maintain a clean, linear git history.

License

See the LICENSE file for license rights and limitations (MIT).