mirror of
https://github.com/wassname/simpeg.git
synced 2026-08-05 13:20:43 +08:00
Documentation updates
This commit is contained in:
rowanc1
+11
-8
@@ -4,6 +4,9 @@
|
||||
SimPEG Maps
|
||||
***********
|
||||
|
||||
Thats not a map...?!
|
||||
====================
|
||||
|
||||
A SimPEG Map operates on a vector and transforms it to another space.
|
||||
We will use an example commonly applied in electromagnetics (EM) of the
|
||||
log-conductivity model.
|
||||
@@ -70,14 +73,6 @@ When these are used in the inverse problem, this is extremely important!!
|
||||
expMap.test(m, plotIt=True)
|
||||
|
||||
|
||||
The API
|
||||
=======
|
||||
|
||||
.. autoclass:: SimPEG.Maps.IdentityMap
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
|
||||
Combining Maps
|
||||
==============
|
||||
|
||||
@@ -127,6 +122,14 @@ Just to be sure that the derivative is correct, you should always run the test
|
||||
on the mapping that you create.
|
||||
|
||||
|
||||
The API
|
||||
=======
|
||||
|
||||
.. autoclass:: SimPEG.Maps.IdentityMap
|
||||
:members:
|
||||
:undoc-members:
|
||||
|
||||
|
||||
Common Maps
|
||||
===========
|
||||
|
||||
|
||||
+6
-1
@@ -4,6 +4,9 @@
|
||||
Solver
|
||||
******
|
||||
|
||||
BYOS
|
||||
====
|
||||
|
||||
The numerical linear algebra solver that you use will ultimately be the
|
||||
bottleneck of your large scale inversion. To be the most flexible, SimPEG
|
||||
provides wrappers rather than a comprehensive set of solvers (i.e. BYOS).
|
||||
@@ -34,7 +37,9 @@ To wrap up solvers in scipy.sparse.linalg it takes one line of code::
|
||||
|
||||
.. seealso::
|
||||
|
||||
https://github.com/rowanc1/pymatsolver
|
||||
- https://bitbucket.org/petsc/petsc4py
|
||||
- https://github.com/bfroehle/pymumps
|
||||
- https://github.com/rowanc1/pymatsolver
|
||||
|
||||
|
||||
The API
|
||||
|
||||
@@ -0,0 +1,17 @@
|
||||
.. _api_license:
|
||||
|
||||
Why SimPEG?
|
||||
***********
|
||||
|
||||
|
||||
The Big Picture
|
||||
===============
|
||||
|
||||
.. image:: simpeg-framework.png
|
||||
:width: 400 px
|
||||
:alt: Framework
|
||||
:align: center
|
||||
|
||||
|
||||
Explaining The Big Picture
|
||||
==========================
|
||||
@@ -0,0 +1,77 @@
|
||||
.. _api_installing:
|
||||
|
||||
Installation
|
||||
************
|
||||
|
||||
Dependencies
|
||||
============
|
||||
|
||||
- Python 2.7
|
||||
- NumPy 1.8 (or greater)
|
||||
- SciPy 0.13 (or greater)
|
||||
- matplotlib 1.3 (or greater)
|
||||
- Cython 0.20 (or greater)
|
||||
|
||||
Installing Python
|
||||
=================
|
||||
|
||||
Python is available on all major operating systems, but if you are getting started with python
|
||||
it is best to use a package manager such as
|
||||
`Continuum Anaconda <https://store.continuum.io/cshop/anaconda/>`_ or
|
||||
`Enthought Canopy <https://www.enthought.com/products/canopy/>`_.
|
||||
You can download the package manager and use it to install the dependencies above.
|
||||
|
||||
|
||||
Installing SimPEG
|
||||
=================
|
||||
|
||||
SimPEG is not **yet** on pip.
|
||||
|
||||
Installing from Source
|
||||
----------------------
|
||||
|
||||
First (you need git)::
|
||||
|
||||
git clone https://github.com/simpeg/simpeg
|
||||
|
||||
Second (from the root of the simpeg repository)::
|
||||
|
||||
python setup.py install
|
||||
|
||||
|
||||
Useful Links
|
||||
============
|
||||
An enormous amount of information (including tutorials and examples) can be found on the official websites of the packages
|
||||
|
||||
* `Python Website <http://www.python.org/>`_
|
||||
* `Numpy Website <http://www.numpy.org/>`_
|
||||
* `SciPy Website <http://www.scipy.org/>`_
|
||||
* `Matplotlib <http://matplotlib.org/>`_
|
||||
|
||||
Python for scientific computing
|
||||
-------------------------------
|
||||
|
||||
* `Python for Scientists <https://sites.google.com/site/pythonforscientists/>`_ Links to commonly used packages, Matlab to Python comparison
|
||||
* `Python Wiki <http://wiki.python.org/moin/NumericAndScientific>`_ Lists packages and resources for scientific computing in Python
|
||||
|
||||
Numpy and Matlab
|
||||
----------------
|
||||
|
||||
* `NumPy for Matlab Users <http://wiki.scipy.org/NumPy_for_Matlab_Users>`_
|
||||
* `Python vs Matlab <https://sites.google.com/site/pythonforscientists/python-vs-matlab>`_
|
||||
|
||||
Lessons in Python
|
||||
-----------------
|
||||
|
||||
* `Software Carpentry <http://software-carpentry.org/v4/python/index.html>`_
|
||||
* `Introduction to NumPy and Matplotlib <http://www.youtube.com/watch?v=3Fp1zn5ao2M>`_
|
||||
|
||||
Editing Python
|
||||
--------------
|
||||
|
||||
There are numerous ways to edit and test Python (see `PythonWiki <http://wiki.python.org/moin/PythonEditors>`_ for an overview) and in our group at least the following options are being used:
|
||||
|
||||
* `Sublime <http://www.sublimetext.com/>`_
|
||||
* `iPython Notebook <http://ipython.org/notebook.html>`_
|
||||
* `iPython <http://ipython.org/>`_
|
||||
* `Enthought Canopy <https://www.enthought.com/products/canopy/>`_
|
||||
@@ -1,11 +1,17 @@
|
||||
.. _api_license:
|
||||
|
||||
License
|
||||
=======
|
||||
*******
|
||||
|
||||
.. include:: ../LICENSE
|
||||
|
||||
Authors
|
||||
=======
|
||||
*******
|
||||
|
||||
.. include:: ../AUTHORS.rst
|
||||
|
||||
|
||||
Projects Using SimPEG
|
||||
*********************
|
||||
|
||||
.. include:: ../PROJECTS.rst
|
||||
|
||||
+34
-28
@@ -1,30 +1,47 @@
|
||||
SimPEG Documentation
|
||||
********************
|
||||
|
||||
.. image:: simpeg-logo.png
|
||||
:width: 300 px
|
||||
:alt: SimPEG
|
||||
:align: center
|
||||
|
||||
Simulation and Parameter Estimation in Geophysics
|
||||
*************************************************
|
||||
SimPEG: Simulation and Parameter Estimation in Geophysics
|
||||
|
||||
SimPEG 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 and parameter estimation with
|
||||
SimPEG is a framework and a collection of tools that aid in the development of
|
||||
large-scale geophysical inversion codes.
|
||||
The vision is to create a modular and extensible 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:
|
||||
|
||||
- is modular with respect to discretization, physics, optimization, and regularization
|
||||
- is modular with respect to ... everything!
|
||||
- is built with the (large-scale) inverse problem in mind
|
||||
- provides a framework for geophysical and hydrogeologic problems
|
||||
- supports 1D, 2D and 3D problems
|
||||
- provides a set of commonly used visualization utilities
|
||||
|
||||
.. image:: simpeg-framework.png
|
||||
:width: 400 px
|
||||
:alt: Framework
|
||||
:align: center
|
||||
|
||||
Meshing & Operators
|
||||
*******************
|
||||
About SimPEG
|
||||
************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api_bigPicture
|
||||
api_license
|
||||
|
||||
|
||||
Getting Started with SimPEG
|
||||
***************************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api_installing
|
||||
|
||||
Discretization
|
||||
**************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 3
|
||||
@@ -60,17 +77,12 @@ Utility Codes
|
||||
api_Solver
|
||||
api_Maps
|
||||
api_Utils
|
||||
|
||||
|
||||
Miscellaneous
|
||||
*************
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
|
||||
api_license
|
||||
api_Tests
|
||||
|
||||
|
||||
Developer's Documentation
|
||||
*************************
|
||||
|
||||
* Travis-CI Testing
|
||||
.. image:: https://travis-ci.org/simpeg/simpeg.svg?branch=master
|
||||
:target: https://travis-ci.org/simpeg/simpeg
|
||||
@@ -84,12 +96,6 @@ Miscellaneous
|
||||
:align: center
|
||||
|
||||
|
||||
|
||||
Projects Using SimPEG
|
||||
*********************
|
||||
|
||||
.. include:: ../PROJECTS.rst
|
||||
|
||||
Project Index & Search
|
||||
**********************
|
||||
|
||||
|
||||
Reference in New Issue
Block a user