Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ install:
conda create --yes -n test python="2.7";
fi
- source activate test
- conda install --yes numpy scipy matplotlib vtk pip nose sip=4.18
- pip install numpy scipy matplotlib vtk nose
- conda install --yes -c https://conda.anaconda.org/dlr-sc pythonocc-core==0.17
- pip install setuptools
- pip install coveralls
Expand Down
21 changes: 3 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,14 +49,13 @@ See the [**Examples**](#examples) section below and the [**Tutorials**](tutorial


## Dependencies and installation
**PyGeM** requires `numpy`, `scipy` and `matplotlib`. They can be easily installed via `pip`.
Moreover **PyGeM** depends on `OCC` and `vtk`. These requirements cannot be satisfied through `pip`.
**PyGeM** requires `numpy`, `scipy`, `matplotlib`, `vtk`, `sphinx` (for the documentation) and `nose` (for local test). They can be easily installed via `pip`.
Moreover **PyGeM** depends on `OCC`. 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.17 | See pythonocc.org or github.com.tpaviot/pythonocc-core for instructions or `conda install -c https://conda.anaconda.org/dlr-sc pythonocc-core==0.17` |
| vtk | >= 5.0 | Simplest solution is `conda install vtk` |


The official distribution is on GitHub, and you can clone the repository using
Expand Down Expand Up @@ -122,7 +121,7 @@ The generated html can be found in `docs/build/html`. Open up the `index.html` y
## Testing
We are using Travis CI for continuous intergration testing. You can check out the current status [here](https://travis-ci.org/mathLab/PyGeM).

To run tests locally:
To run tests locally (the package `nose` is required):

```bash
> python test.py
Expand Down Expand Up @@ -153,20 +152,6 @@ Here we show three applications, taken from the **naval**, **nautical** and **au
<em>DrivAer model: morphing of the bumper starting from an OpenFOAM mesh file.</em>
</p>


## Graphical User Interface
**PyGeM** is now provided with a very basic Graphical User 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. For a demonstration, see the [video tutorial on YouTube](https://youtu.be/iAjGEhXs_ys).

<p align="center">
<img src="readme/gui_PyGeM.png" alt>
</p>
<p align="center">
<em>PyGeM GUI: how it appears when it pops up.</em>
</p>


## How to cite
If you use this package in your publications please cite the package as follows:

Expand Down
6 changes: 0 additions & 6 deletions docs/source/_summaries/pygem.gui.Gui._chose_geometry.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/_summaries/pygem.gui.Gui._chose_parameters.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/_summaries/pygem.gui.Gui._goto_website.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/_summaries/pygem.gui.Gui._main.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/_summaries/pygem.gui.Gui._run_simulation.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/_summaries/pygem.gui.Gui.start.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/source/_summaries/pygem.idw.IDW.perform.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
pygem\.idw\.IDW\.perform
========================
pygem.idw.IDW.perform
=====================

.. currentmodule:: pygem.idw

Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.ffdparams.FFDParameters.build_bounding_box
=======================================================

.. currentmodule:: pygem.params.ffdparams

.. automethod:: FFDParameters.build_bounding_box
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.ffdparams.FFDParameters.inv_psi_mapping
====================================================

.. currentmodule:: pygem.params.ffdparams

.. autoattribute:: FFDParameters.inv_psi_mapping
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.ffdparams.FFDParameters.position_vertices
======================================================

.. currentmodule:: pygem.params.ffdparams

.. autoattribute:: FFDParameters.position_vertices
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.ffdparams.FFDParameters.psi_mapping
================================================

.. currentmodule:: pygem.params.ffdparams

.. autoattribute:: FFDParameters.psi_mapping
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.ffdparams.FFDParameters.read_parameters
====================================================

.. currentmodule:: pygem.params.ffdparams

.. automethod:: FFDParameters.read_parameters
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.ffdparams.FFDParameters.reset_deformation
======================================================

.. currentmodule:: pygem.params.ffdparams

.. automethod:: FFDParameters.reset_deformation
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.ffdparams.FFDParameters.rotation_matrix
====================================================

.. currentmodule:: pygem.params.ffdparams

.. autoattribute:: FFDParameters.rotation_matrix
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.ffdparams.FFDParameters.save
=========================================

.. currentmodule:: pygem.params.ffdparams

.. automethod:: FFDParameters.save
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.ffdparams.FFDParameters.write_parameters
=====================================================

.. currentmodule:: pygem.params.ffdparams

.. automethod:: FFDParameters.write_parameters
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.idwparams.IDWParameters.read_parameters
====================================================

.. currentmodule:: pygem.params.idwparams

.. automethod:: IDWParameters.read_parameters
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.idwparams.IDWParameters.write_parameters
=====================================================

.. currentmodule:: pygem.params.idwparams

.. automethod:: IDWParameters.write_parameters
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.rbfparams.RBFParameters.n_control_points
=====================================================

.. currentmodule:: pygem.params.rbfparams

.. autoattribute:: RBFParameters.n_control_points
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.rbfparams.RBFParameters.read_parameters
====================================================

.. currentmodule:: pygem.params.rbfparams

.. automethod:: RBFParameters.read_parameters
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.rbfparams.RBFParameters.save
=========================================

.. currentmodule:: pygem.params.rbfparams

.. automethod:: RBFParameters.save
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
pygem.params.rbfparams.RBFParameters.write_parameters
=====================================================

.. currentmodule:: pygem.params.rbfparams

.. automethod:: RBFParameters.write_parameters

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
pygem.radial.RBF.polyharmonic_spline
==================================
====================================

.. currentmodule:: pygem.radial

.. automethod:: RBF.polyharmonic_spline
.. automethod:: RBF.polyharmonic_spline
6 changes: 0 additions & 6 deletions docs/source/_summaries/pygem.utils._write_vtk_box.rst

This file was deleted.

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/_summaries/pygem.utils.write_bounding_box.rst

This file was deleted.

6 changes: 0 additions & 6 deletions docs/source/_summaries/pygem.utils.write_points_in_vtp.rst

This file was deleted.

2 changes: 1 addition & 1 deletion docs/source/affine.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Affine

.. automodule:: pygem.affine
:members:

:noindex:
Loading