.. meshmagick documentation master file, created by
   sphinx-quickstart on Mon Dec  5 15:13:47 2016.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Meshmagick User's Guide (|version|)
===================================

**Meshmagick** is a command line utility as well as a python module for the manipulation of meshes encountered in the
hydrodynamics community.

Its primary goal was to be a conversion tool between major file formats for hydrodynamic computations tools (Nemoh,
Wamit, Hydrostar or Diodore) and visualization tools (stl, Tecplot, Paraview). It will be particularly useful for code
to code comparisons or benchmarking.

**Meshmagick** also comes with several mesh manipulation capabilities: translation, rotation, scaling, clipping by a
plane, symmetry, normals flipping, normals healing (making them consistent across the mesh and outgoing), cleaning
(duplicate nodes merging...).

As of the release 1.0, **meshmagick** provides useful options for hydrostatics computations. It can solve for
hydrostatics equilibrium for a given mass, center of gravity or both and provide the clipped mesh to be used by BEM
software as well as the hydrostatics parameters (stiffness matrix, position of the center of buoyancy, displacement,
draft...).

**Meshmagick** is primarily a command line utility for everyday hydrodynamicists. However, it also comes with a
package that can be imported in a python script and give the full access to the command line options, programmatically.

.. todo: regenerer l'image avec ce qui est donne dessous
.. image:: img/screenshot.png

This picture above has been generated by issuing the following command line::

    >$ meshmagick SEAREV.vtp -hs --disp 800 -af 0 -15 -5 0 0 -2000000 -af 0 15 -5 0 0 -6000000 --show

The **GitHub** repository is at the following address:

    https://github.com/LHEEA/meshmagick

Meshmagick is the property of **Ecole Centrale de Nantes** and is released under the **GNU GPLv3** open source licence
(see
LICENCE).

**Maintainer**: François Rongère <francois.rongere@ec-nantes.fr>


Getting Meshmagick
==================

.. toctree::
    :maxdepth: 2

    install/install


Using Meshmagick as a command line tool
=======================================

.. toctree::
    :maxdepth: 2

    command_line/index

Meshmagick's API reference
==========================

.. toctree::
    :maxdepth: 2

    api/index

Indices and tables
------------------

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`