mirror of
https://github.com/wassname/simpeg.git
synced 2026-07-07 22:38:36 +08:00
organizing the docs - put the content in a content folder. put the SimPEG core api docs in core_api
This commit is contained in:
@@ -0,0 +1,80 @@
|
||||
.. _api_installing:
|
||||
|
||||
Getting Started with SimPEG
|
||||
***************************
|
||||
|
||||
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 on pip!!::
|
||||
|
||||
pip install SimPEG
|
||||
|
||||
|
||||
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/>`_
|
||||
Reference in New Issue
Block a user