From 66ccdb4042f6d96c28621aff77713627150a44b0 Mon Sep 17 00:00:00 2001 From: rowanc1 Date: Fri, 7 Feb 2014 10:51:44 -0800 Subject: [PATCH] Updates to travis and documentation --- .travis.yml | 8 ++++++-- docs/{api_DC.rst => api_FDEM.rst} | 8 ++++---- docs/api_TDEM.rst | 21 +++++++++++++++++++++ docs/api_Utils.rst | 23 +++++++++++++++++++++++ docs/index.rst | 27 +++++++++++++++++++++------ 5 files changed, 75 insertions(+), 12 deletions(-) rename docs/{api_DC.rst => api_FDEM.rst} (54%) create mode 100644 docs/api_TDEM.rst create mode 100644 docs/api_Utils.rst diff --git a/.travis.yml b/.travis.yml index fd11e461..6b2e2cff 100644 --- a/.travis.yml +++ b/.travis.yml @@ -4,10 +4,14 @@ python: virtualenv: system_site_packages: true before_install: - - sudo apt-get install -qq python-numpy python-scipy python-matplotlib + - sudo apt-get install -qq gcc gfortran libblas-dev liblapack-dev python-numpy python-scipy python-matplotlib python-pip + - sudo pip install scipy --upgrade + - sudo pip install numpy --upgrade - cd ../ - git clone https://github.com/simpeg/simpeg.git - - python simpeg/SimPEG/setup.py + - cd simpeg/SimPEG/ + - python setup.py + - cd ../../ - echo export PYTHONPATH=$PYTHONPATH:/home/travis/build/simpeg/simpeg >> .bashrc - source .bashrc - cd simpegem diff --git a/docs/api_DC.rst b/docs/api_FDEM.rst similarity index 54% rename from docs/api_DC.rst rename to docs/api_FDEM.rst index 5d3410a3..36f57ab2 100644 --- a/docs/api_DC.rst +++ b/docs/api_FDEM.rst @@ -1,10 +1,10 @@ -.. _api_DC: +.. _api_FDEM: -DC -** +Base Classes +************ -.. automodule:: simpegDC.DC +.. automodule:: simpegEM.FDEM :show-inheritance: :members: :undoc-members: diff --git a/docs/api_TDEM.rst b/docs/api_TDEM.rst new file mode 100644 index 00000000..4827a43b --- /dev/null +++ b/docs/api_TDEM.rst @@ -0,0 +1,21 @@ +.. _api_TDEM: + + +Base Classes +************ + +.. automodule:: simpegEM.TDEM.BaseTDEM + :show-inheritance: + :members: + :undoc-members: + :inherited-members: + + +TDEM - B formulation +******************** + +.. automodule:: simpegEM.TDEM.TDEM_b + :show-inheritance: + :members: + :undoc-members: + :inherited-members: diff --git a/docs/api_Utils.rst b/docs/api_Utils.rst new file mode 100644 index 00000000..ef96eaf3 --- /dev/null +++ b/docs/api_Utils.rst @@ -0,0 +1,23 @@ +.. _api_Utils: + + +Analytic Functions +****************** + +.. automodule:: simpegEM.Utils.Ana.TEM + :show-inheritance: + :members: + :undoc-members: + :inherited-members: + + +Sources +******* + +.. automodule:: simpegEM.Utils.Sources.magneticDipole + :show-inheritance: + :members: + :undoc-members: + :inherited-members: + + diff --git a/docs/index.rst b/docs/index.rst index 0012e2f4..64cce4c3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,17 +7,32 @@ SimPEG (Simulation and Parameter Estimation in Geophysics) is a python package for simulation and gradient based parameter estimation in the context of geoscience applications. -SimPEG-DC uses SimPEG as the framework for the forward and inverse -direct current resistivity geophysical problem. +SimPEG-EM uses SimPEG as the framework for the forward and inverse +electromagnetics geophysical problems. - -DC -== +Time Domian Electromagnetics +============================ .. toctree:: :maxdepth: 2 - api_DC + api_TDEM + +Frequency Domian Electromagnetics +================================= + +.. toctree:: + :maxdepth: 2 + + api_FDEM + +Utils +===== + +.. toctree:: + :maxdepth: 2 + + api_Utils Testing SimPEG