Removed the fatiando.gui package

Moved the Moulder class to gravmag.interactive. Deleted the other classes and their respective cookbook recipes. Updated docs accordingly.
ncvangilse · Nov 23, 2014 · e813073 · e813073
1 parent 829dd8b
commit e813073
Show file tree

Hide file tree

Showing 15 changed files with 649 additions and 857 deletions.
diff --git a/cookbook/gravmag_2d_polygon_interactive.py b/cookbook/gravmag_2d_polygon_interactive.py
@@ -2,7 +2,7 @@
 GravMag: Interactive 2D forward modeling with polygons
 """
 import numpy
-from fatiando.gui.simple import Moulder
+from fatiando.gravmag.interactive import Moulder
 
 area = (0, 100000, 0, 5000)
 xp = numpy.arange(0, 100000, 1000)

diff --git a/cookbook/gravmag_basin2d_trapezoidal_forward.py b/cookbook/gravmag_basin2d_trapezoidal_forward.py
diff --git a/cookbook/gravmag_basin2d_triangular_forward.py b/cookbook/gravmag_basin2d_triangular_forward.py
diff --git a/cookbook/seismic_profile_vertical_interactive.py b/cookbook/seismic_profile_vertical_interactive.py
diff --git a/doc/api/fatiando.rst b/doc/api/fatiando.rst
@@ -16,7 +16,6 @@ API Reference: The ``fatiando`` package
     gridder.rst
     vis.rst
     datasets.rst
-    gui.rst
     utils.rst
     constants.rst
     inversion.rst

diff --git a/doc/api/gravmag.interactive.rst b/doc/api/gravmag.interactive.rst
@@ -0,0 +1,9 @@
+.. _fatiando_gravmag_interactive:
+
+Interactivity through functions and classes (``fatiando.gravmag.interactive``)
+==============================================================================
+
+.. automodule:: fatiando.gravmag.interactive
+    :members:
+    :show-inheritance:
+
diff --git a/doc/api/gravmag.rst b/doc/api/gravmag.rst
@@ -25,3 +25,4 @@ Gravity and magnetics (``fatiando.gravmag``)
     gravmag.half_sph_shell.rst
     gravmag.magdir.rst
     gravmag.normal_gravity.rst
+    gravmag.interactive.rst
diff --git a/doc/api/gui.rst b/doc/api/gui.rst
diff --git a/doc/api/gui.simple.rst b/doc/api/gui.simple.rst
diff --git a/doc/conf.py b/doc/conf.py
@@ -42,8 +42,13 @@ def __getattr__(self, name):
     'scipy.special', 'scipy.interpolate',
     'matplotlib',
     'matplotlib.mlab', 'matplotlib.pyplot', 'matplotlib.widgets',
-    'matplotlib.nxutils',
-    'PIL.Image']
+    'matplotlib.nxutils', 'matplotlib.lines',
+    'PIL.Image',
+    'IPython',
+    'IPython.core',
+    'IPython.core.pylabtools',
+    'IPython.display',
+    ]
 for mod_name in MOCK_MODULES:
     sys.modules[mod_name] = Mock()
 

diff --git a/fatiando/__init__.py b/fatiando/__init__.py
@@ -21,8 +21,6 @@
   Plotting utilities for 2D (using matplotlib) and 3D (using mayavi)
 * :mod:`datasets <fatiando.datasets>`:
   Fetch and load datasets and models from web repositories
-* :mod:`gui <fatiando.gui>`:
-  Graphical user interfaces (still very primitive)
 * :mod:`utils <fatiando.utils>`:
   Miscelaneous utilities, like mathematical functions, unit conversion, etc
 * :mod:`~fatiando.constants`:

diff --git a/fatiando/gravmag/__init__.py b/fatiando/gravmag/__init__.py
@@ -49,6 +49,12 @@
 * :mod:`~fatiando.gravmag.tensor`: Utilities for operating on the gradient
   tensor
 
+**Interactivity**
+
+Module :mod:`~fatiando.gravmag.interactive` implements matplotlib GUIs and
+IPython HTML widgets for interacting with the modeling and processing
+functions.
+
 ----
 
 """