Update and rename README.md to README.rst

This commit is contained in:
Rowan Cockett
2014-07-03 15:26:06 -07:00
parent 00ade54cef
commit 596395ac32
2 changed files with 60 additions and 33 deletions
-33
View File
@@ -1,33 +0,0 @@
![SimPEG](https://raw.github.com/simpeg/simpeg/master/docs/simpeg-logo.png)
[![Build Status](https://travis-ci.org/simpeg/simpeg.svg?branch=master)](https://travis-ci.org/simpeg/simpeg)
[![Coverage Status](https://coveralls.io/repos/simpeg/simpeg/badge.png?branch=master)](https://coveralls.io/r/simpeg/simpeg?branch=master)
[![Downloads](https://pypip.in/download/SimPEG/badge.png)](https://pypi.python.org/pypi/SimPEG/)
[![Latest Version](https://pypip.in/version/SimPEG/badge.png)](https://pypi.python.org/pypi/SimPEG/)
[![License](https://pypip.in/license/SimPEG/badge.png)](https://pypi.python.org/pypi/SimPEG/)
Simulation and Parameter Estimation in Geophysics - A python package for simulation and gradient based parameter estimation in the context of geophysical 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:
* modular with respect to the spacial discretization, optimization routine, and geophysical problem
* built with the inverse problem in mind
* provides a framework for geophysical and hydrogeologic problems
* supports 1D, 2D and 3D problems
* designed for large-scale inversions
Documentation:
[http://simpeg.readthedocs.org/en/latest/](http://simpeg.readthedocs.org/en/latest/)
Code:
[https://github.com/simpeg/simpeg](https://github.com/simpeg/simpeg)
Tests:
[https://travis-ci.org/simpeg/simpeg](https://travis-ci.org/simpeg/simpeg)
Bugs & Issues:
[https://github.com/simpeg/simpeg/issues](https://github.com/simpeg/simpeg/issues)
Code Snippets & Tutorials:
[http://www.row1.ca/simpeg](http://www.row1.ca/simpeg)
+60
View File
@@ -0,0 +1,60 @@
.. image:: https://raw.github.com/simpeg/simpeg/master/docs/simpeg-logo.png
:alt: SimPEG Logo
======
SimPEG
======
.. image:: http://img.shields.io/pypi/v/SimPEG.svg
:target: https://crate.io/packages/SimPEG/
:alt: Latest PyPI version
.. image:: http://img.shields.io/pypi/dm/SimPEG.svg
:target: https://crate.io/packages/SimPEG/
:alt: Number of PyPI downloads
.. image:: http://img.shields.io/badge/license-BSD-lightgrey.svg
:target: https://github.com/simpeg/simpeg/blob/master/LICENSE.txt
:alt: BSD 3 clause license.
.. image:: http://img.shields.io/travis/simpeg/simpeg.svg
:target: https://travis-ci.org/simpeg/simpeg
:alt: Travis CI build status
.. image:: http://img.shields.io/coveralls/simpeg/simpeg.svg
:target: https://coveralls.io/r/simpeg/simpeg?branch=master
Simulation and Parameter Estimation in Geophysics - A python package for simulation and gradient based parameter estimation in the context of geophysical 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:
* modular with respect to the spacial discretization, optimization routine, and geophysical problem
* built with the inverse problem in mind
* provides a framework for geophysical and hydrogeologic problems
* supports 1D, 2D and 3D problems
* designed for large-scale inversions
Documentation:
http://simpeg.readthedocs.org/en/latest/
Code:
https://github.com/simpeg/simpeg
Tests:
https://travis-ci.org/simpeg/simpeg
Bugs & Issues:
https://github.com/simpeg/simpeg/issues
Code Snippets & Tutorials
:
http://www.row1.ca/simpeg