Merge pull request #24 from groupeLIAMG/dev

use travis + minor fixes

.gitignore

@@ -10,6 +10,10 @@ ttcr_matlab/*.mex*
 xcuserdata/
 someTests/
 
+ttcrpy.egg-info/
+
+ttcrpy-0*
+
 ttcrpy/__pycache__/
 
 dynamicNodes.svg
@@ -43,3 +47,5 @@ ttcrpy/cmesh3d.cp36-win_amd64.pyd
 ttcrpy/cmesh3d.cp37-win_amd64.pyd
 
 examples/example_cmesh2d.vtu
+
+docs/_build/

.travis.yml

@@ -0,0 +1,24 @@
+notifications:
+  email: false
+matrix:
+  include:
+  - sudo: required
+    services:
+    - docker
+    env: DOCKER_IMAGE=quay.io/pypa/manylinux1_x86_64 PLAT=manylinux1_x86_64
+  - sudo: required
+    services:
+    - docker
+    env: DOCKER_IMAGE=quay.io/pypa/manylinux2010_x86_64 PLAT=manylinux2010_x86_64
+install:
+- docker pull $DOCKER_IMAGE
+script:
+- docker run --rm -e PLAT=$PLAT -v `pwd`:/io $DOCKER_IMAGE $PRE_CMD /io/travis/build-linux-wheels.sh
+- ls wheelhouse/
+
+
+deploy:
+  provider: pypi
+  user: "__token__"
+  password:
+    secure: OVp/3WuMinD5f+LWGS4l1mADB9fhieBIIJwxgcnmnnRtltuvBw94XFQEhNe+mrVnR8V0V8rvoKMoypa/qQHs/5pz0xP6MD6M1ch9legMrDBRLVJXEinFdr2C7Mr2SQa5XWyLqTCJCjpmTESjQ2jG45KF+dfGR97U+eF9pYWU6oP2CypFy1hR2AaZSt2O94IaHQeEDXSwRQLPNIewbz38muD1fm7MOd2FlSZuv0GztBMW6CuKx7XAW4UlJmsnJJprT46uBWDlWmkOon7J1qkZLlHwUXb6IZVwyKsphUCyM/RoszxgQpMomIolAyuHHlpGQJMsDhXz3WQqvvW7P+a4aUR0yMSpE/oKMDNrlgoxrkxO8vAmCpSrsXict+HmmcUrAXTfvdQ86/Zax8gTFNiVnOaUPpVDc18QJryGCljdUB1sSoUEateQ+FovD6nfSfYnLH3C367X8ZBNcTF34DXfaNHt/5aUxxhaGMHhm7uysl1WbdyDIS52WB5Pch1IZEM6c0NmYtUe3ISiY63q1BpHl5ly59A6cVNcMQxbY/X556x7MHmcpXBS4dAJVhYC+V2QaOrY/qIUDj4QXlX3Va02Kb7ALZPyTb08B72yjulYuQkZz1ICYeN0f7X9AuyxdWvU3jpANDUGFxKljQk7BFBkwjNpg8gLDEJPSJQVScJeMn0=

docs/_build/html/_sources/code.rst.txt

@@ -1,3 +1,4 @@
+*********************************
 Documentation for the python code
 *********************************
 

docs/_build/html/_sources/code_cgrid2d.rst.txt

@@ -1,5 +1,5 @@
 Module cgrid2d
-**************
+==============
 
 .. automodule:: ttcrpy.cgrid2d
    :members:

docs/_build/html/_sources/code_cgrid3d.rst.txt

@@ -1,5 +1,5 @@
 Module cgrid3d
-**************
+==============
 
 .. automodule:: ttcrpy.cgrid3d
    :members:

docs/_build/html/_sources/code_cmesh2d.rst.txt

@@ -1,5 +1,5 @@
 Module cmesh2d
-**************
+==============
 
 .. automodule:: ttcrpy.cmesh2d
    :members:

docs/_build/html/_sources/code_cmesh3d.rst.txt

@@ -1,5 +1,5 @@
 Module cmesh3d
-**************
+==============
 
 .. automodule:: ttcrpy.cmesh3d
    :members:

docs/_build/html/_sources/code_grid.rst.txt

@@ -1,5 +1,5 @@
 Module grid
-************
+===========
 
 .. automodule:: ttcrpy.grid
    :members:

docs/_build/html/_sources/code_rgrid.rst.txt

@@ -1,6 +1,6 @@
 
 Module rgrid
-************
+============
 
 .. automodule:: ttcrpy.rgrid
    :members:

docs/_build/html/_sources/getting_started.rst.txt

@@ -1,21 +1,22 @@
 .. _getting_started:
 
 
-***************
+###############
 Getting started
-***************
+###############
 
 .. _installing-ttcrpy:
 
+*****************
 Installing ttcrpy
-=================
+*****************
 
 You can use pip to install the package by doing::
 
   pip install ttcrpy
 
 Requirements
-------------
+============
 
 ttcrpy needs the following modules:
   - numpy (https://numpy.org)

docs/_build/html/_sources/index.rst.txt

@@ -3,19 +3,22 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
+##################################
 Welcome to ttcrpy's documentation!
-==================================
+##################################
 
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    getting_started.rst
+   model_discretization.rst
    code.rst
 
 
+##################
 Indices and tables
-==================
+##################
 
 * :ref:`genindex`
 * :ref:`modindex`

docs/_build/html/_sources/model_discretization.rst.txt

@@ -0,0 +1,36 @@
+********************
+Model discretization
+********************
+
+``ttcrpy`` supports a number of discretization schemes.  2D and 3D models are possible.
+
+2D models
+=========
+
+Rectilinear grids and triangular meshes can be built to perform the calculations.
+By convention, the coordinate axis system is (x, z), e.g. when saving the models to
+VTK format.
+
+3D models
+=========
+
+Rectilinear grids and tetraedral meshes can be used for 3D calculations.
+
+Assigning velocity/slowness
+===========================
+
+Prior to performing traveltime computations, it is necessary to define the slowness
+distribution in space. Two options are possible.
+
+.. image:: images/discr1.*
+   :width: 300px
+   :alt: slowness assigned to cells
+
+.. image::  images/discr2.*
+   :width: 300px
+   :alt: slowness assigned to nodes
+
+In the leftmost case, slowness values are assigned to the cells of the mesh.
+In the rightmost case, slowness values are assigned to grid nodes.  In the latter case, traveltime
+computation between two nodes is done by taking the average of the slowness
+values at the two nodes.

docs/_build/html/code.html

@@ -15,7 +15,7 @@
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
     <link rel="next" title="Module rgrid" href="code_rgrid.html" />
-    <link rel="prev" title="Getting started" href="getting_started.html" /> 
+    <link rel="prev" title="Model discretization" href="model_discretization.html" /> 
   </head><body>
 
 <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
@@ -35,7 +35,7 @@ <h3>Navigation</h3>
           <a href="code_rgrid.html" title="Module rgrid"
              accesskey="N">next</a> |</li>
         <li class="right" >
-          <a href="getting_started.html" title="Getting started"
+          <a href="model_discretization.html" title="Model discretization"
              accesskey="P">previous</a> |</li>
         <li><a href="index.html">home</a>|&nbsp;</li>
         <li><a href="search.html">search</a>|&nbsp;</li>
@@ -46,8 +46,8 @@ <h3>Navigation</h3>
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
   <h4>Previous topic</h4>
-  <p class="topless"><a href="getting_started.html"
-                        title="previous chapter">Getting started</a></p>
+  <p class="topless"><a href="model_discretization.html"
+                        title="previous chapter">Model discretization</a></p>
   <h4>Next topic</h4>
   <p class="topless"><a href="code_rgrid.html"
                         title="next chapter">Module rgrid</a></p>
@@ -111,7 +111,7 @@ <h3>Navigation</h3>
           <a href="code_rgrid.html" title="Module rgrid"
              >next</a> |</li>
         <li class="right" >
-          <a href="getting_started.html" title="Getting started"
+          <a href="model_discretization.html" title="Model discretization"
              >previous</a> |</li>
         <li><a href="index.html">home</a>|&nbsp;</li>
         <li><a href="search.html">search</a>|&nbsp;</li>

docs/_build/html/code_cgrid2d.html

@@ -14,6 +14,7 @@
     <script src="_static/language_data.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Module cgrid3d" href="code_cgrid3d.html" />
     <link rel="prev" title="Module rgrid" href="code_rgrid.html" /> 
   </head><body>
 
@@ -30,6 +31,9 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="code_cgrid3d.html" title="Module cgrid3d"
+             accesskey="N">next</a> |</li>
         <li class="right" >
           <a href="code_rgrid.html" title="Module rgrid"
              accesskey="P">previous</a> |</li>
@@ -45,6 +49,9 @@ <h3>Navigation</h3>
   <h4>Previous topic</h4>
   <p class="topless"><a href="code_rgrid.html"
                         title="previous chapter">Module rgrid</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="code_cgrid3d.html"
+                        title="next chapter">Module cgrid3d</a></p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -197,6 +204,9 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="code_cgrid3d.html" title="Module cgrid3d"
+             >next</a> |</li>
         <li class="right" >
           <a href="code_rgrid.html" title="Module rgrid"
              >previous</a> |</li>

docs/_build/html/code_cgrid3d.html

@@ -13,7 +13,9 @@
     <script src="_static/doctools.js"></script>
     <script src="_static/language_data.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" /> 
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Module cmesh2d" href="code_cmesh2d.html" />
+    <link rel="prev" title="Module cgrid2d" href="code_cgrid2d.html" /> 
   </head><body>
 
 <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
@@ -29,14 +31,27 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="code_cmesh2d.html" title="Module cmesh2d"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="code_cgrid2d.html" title="Module cgrid2d"
+             accesskey="P">previous</a> |</li>
         <li><a href="index.html">home</a>|&nbsp;</li>
         <li><a href="search.html">search</a>|&nbsp;</li>
-
+
+          <li class="nav-item nav-item-1"><a href="code.html" accesskey="U">Documentation for the python code</a> &#187;</li> 
       </ul>
     </div>
 
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="code_cgrid2d.html"
+                        title="previous chapter">Module cgrid2d</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="code_cmesh2d.html"
+                        title="next chapter">Module cmesh2d</a></p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -259,9 +274,16 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="code_cmesh2d.html" title="Module cmesh2d"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="code_cgrid2d.html" title="Module cgrid2d"
+             >previous</a> |</li>
         <li><a href="index.html">home</a>|&nbsp;</li>
         <li><a href="search.html">search</a>|&nbsp;</li>
-
+
+          <li class="nav-item nav-item-1"><a href="code.html" >Documentation for the python code</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">

docs/_build/html/code_cmesh2d.html

@@ -13,7 +13,9 @@
     <script src="_static/doctools.js"></script>
     <script src="_static/language_data.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" /> 
+    <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Module cmesh3d" href="code_cmesh3d.html" />
+    <link rel="prev" title="Module cgrid3d" href="code_cgrid3d.html" /> 
   </head><body>
 
 <div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">
@@ -29,14 +31,27 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="code_cmesh3d.html" title="Module cmesh3d"
+             accesskey="N">next</a> |</li>
+        <li class="right" >
+          <a href="code_cgrid3d.html" title="Module cgrid3d"
+             accesskey="P">previous</a> |</li>
         <li><a href="index.html">home</a>|&nbsp;</li>
         <li><a href="search.html">search</a>|&nbsp;</li>
-
+
+          <li class="nav-item nav-item-1"><a href="code.html" accesskey="U">Documentation for the python code</a> &#187;</li> 
       </ul>
     </div>
 
       <div class="sphinxsidebar" role="navigation" aria-label="main navigation">
         <div class="sphinxsidebarwrapper">
+  <h4>Previous topic</h4>
+  <p class="topless"><a href="code_cgrid3d.html"
+                        title="previous chapter">Module cgrid3d</a></p>
+  <h4>Next topic</h4>
+  <p class="topless"><a href="code_cmesh3d.html"
+                        title="next chapter">Module cmesh3d</a></p>
   <div role="note" aria-label="source link">
     <h3>This Page</h3>
     <ul class="this-page-menu">
@@ -180,9 +195,16 @@ <h3>Navigation</h3>
         <li class="right" >
           <a href="py-modindex.html" title="Python Module Index"
              >modules</a> |</li>
+        <li class="right" >
+          <a href="code_cmesh3d.html" title="Module cmesh3d"
+             >next</a> |</li>
+        <li class="right" >
+          <a href="code_cgrid3d.html" title="Module cgrid3d"
+             >previous</a> |</li>
         <li><a href="index.html">home</a>|&nbsp;</li>
         <li><a href="search.html">search</a>|&nbsp;</li>
-
+
+          <li class="nav-item nav-item-1"><a href="code.html" >Documentation for the python code</a> &#187;</li> 
       </ul>
     </div>
     <div class="footer" role="contentinfo">