From 53233e25e59c894b90603b17cb0e09d0baa3526e Mon Sep 17 00:00:00 2001 From: rowanc1 Date: Wed, 18 Dec 2013 11:19:42 -0800 Subject: [PATCH] documentation updates. --- SimPEG/utils/Save.py | 2 +- docs/index.rst | 21 +++++++++++++++------ 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/SimPEG/utils/Save.py b/SimPEG/utils/Save.py index cad7cf58..4ad550de 100644 --- a/SimPEG/utils/Save.py +++ b/SimPEG/utils/Save.py @@ -266,7 +266,7 @@ def saveSavable(obj, group, debug=False): try: grp.attrs[name] = val except Exception, e: - print 'Warning: Could not save %s, problems may arise is loading.' % name + print 'Warning: Could not save %s, problems may arise in loading.' % name group.attrs['__class__'] = obj.__class__.__name__ for arg in obj._kwargs_init: diff --git a/docs/index.rst b/docs/index.rst index b008e963..b2b9806f 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -3,14 +3,23 @@ :alt: SimPEG :align: center -SimPEG (Simulation and Parameter Estimation in Geophysics) is a python package for simulation and gradient based parameter estimation in the context of geophysical applications. +SimPEG (Simulation and Parameter Estimation in Geoscience) is a python +package for simulation and gradient based parameter estimation in the +context of geoscience applications. -The vision is to create a package for finite volume simulation with applications to geophysical imaging and subsurface flow. To enable the understanding of the many different components, this package has the following features: +The vision is to create a package for finite volume simulation and parameter estimation with +applications to geophysical imaging and subsurface flow. To enable +these goals, this package has the following features: -* modular with respect to the spacial discretization -* is built with the inverse problem in mind -* supports different hyperbolic solvers (Euler, Semi-Lagrangian, Lagrangian) -* supports 2D and 3D problems +* is modular with respect to discretization, physics, optimization, and regularization +* is built with the (large-scale) inverse problem in mind +* provides a framework for geophysical and hydrogeologic problems +* supports 1D, 2D and 3D problems + + +.. raw:: html + + Meshing & Operators