Merge pull request #842 from obspy/reorganization

Reorganization of ObsPy submodule structure
obspy · Mar 24, 2015 · d5213da · d5213da
2 parents 45a0467 + e3f993f
commit d5213da
Show file tree

Hide file tree

Showing 895 changed files with 3,060 additions and 3,669 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -59,7 +59,7 @@ script:
   - mkdir empty
   - cd empty
   - MODULELIST=`python -c "from obspy.core.util import DEFAULT_MODULES as MODULES; print('obspy.' + ',obspy.'.join(MODULES))"`
-  - coverage run --rcfile=.coveragerc --source=$MODULELIST -m obspy.core.scripts.runtests -n travis-ci -r
+  - coverage run --rcfile=.coveragerc --source=$MODULELIST -m obspy.scripts.runtests -n travis-ci -r
 after_success:
   - mv .coverage ../.coverage.empty
   - cd ..

diff --git a/appveyor.yml b/appveyor.yml
@@ -44,4 +44,4 @@ build: false
 
 test_script:
   - "%CMD_IN_ENV% python setup.py develop"
-  - "python -m obspy.core.scripts.runtests -n appveyor-ci -r"
+  - "python -m obspy.scripts.runtests -n appveyor-ci -r"
diff --git a/misc/docs/source/packages/index.rst b/misc/docs/source/packages/index.rst
@@ -11,59 +11,71 @@ The functionality is provided through the following packages:
    :nosignatures:
 
    obspy.core
+   obspy.geodetics
    obspy.imaging
    obspy.realtime
    obspy.signal
-   obspy.station
    obspy.taup
-   obspy.xseed
+   obspy.io.xseed
+
+.. rubric:: Scripts
+
+.. autosummary::
+   :template: script.rst
+   :toctree: autogen
+   :nosignatures:
+
+   obspy.scripts.runtests
+   obspy.scripts.reftekrescue
 
 .. rubric:: Waveform Import/Export Plug-ins
 
 .. autosummary::
    :toctree: .
    :nosignatures:
 
-   obspy.ah
-   obspy.css
-   obspy.datamark
-   obspy.gse2
-   obspy.kinemetrics
-   obspy.mseed
-   obspy.pdas
-   obspy.sac
-   obspy.seisan
-   obspy.seg2
-   obspy.segy
-   obspy.sh
-   obspy.wav
-   obspy.y
+   obspy.io.ah
+   obspy.io.ascii
+   obspy.io.css
+   obspy.io.datamark
+   obspy.io.gse2
+   obspy.io.kinemetrics
+   obspy.io.mseed
+   obspy.io.pdas
+   obspy.io.sac
+   obspy.io.seisan
+   obspy.io.seg2
+   obspy.io.segy
+   obspy.io.sh
+   obspy.io.wav
+   obspy.io.y
 
 .. rubric:: Event Data Import/Export Plug-ins
 
 .. autosummary::
    :toctree: .
    :nosignatures:
 
-   obspy.core.quakeml
-   obspy.cnv
-   obspy.ndk
-   obspy.nlloc
-   obspy.pde
-   obspy.zmap
+   obspy.io.cnv
+   obspy.io.json
+   obspy.io.ndk
+   obspy.io.nlloc
+   obspy.io.pde
+   obspy.io.quakeml
+   obspy.io.zmap
 
 .. rubric:: Database or Web Service Access Clients
 
 .. autosummary::
    :toctree: .
    :nosignatures:
 
-   obspy.arclink
+   obspy.clients.arclink
+   obspy.clients.earthworm
+   obspy.clients.fdsn
+   obspy.clients.iris
+   obspy.clients.neic
+   obspy.clients.neries
+   obspy.clients.seedlink
+   obspy.clients.seishub
    obspy.db
-   obspy.earthworm
-   obspy.fdsn
-   obspy.iris
-   obspy.neic
-   obspy.neries
-   obspy.seedlink
-   obspy.seishub
diff --git a/misc/docs/source/packages/obspy.ah.rst b/misc/docs/source/packages/obspy.ah.rst
diff --git a/misc/docs/source/packages/obspy.arclink.rst b/misc/docs/source/packages/obspy.arclink.rst
diff --git a/misc/docs/source/packages/obspy.clients.arclink.rst b/misc/docs/source/packages/obspy.clients.arclink.rst
@@ -0,0 +1,24 @@
+.. currentmodule:: obspy.clients.arclink
+.. automodule:: obspy.clients.arclink
+
+    .. comment to end block
+
+    Classes & Functions
+    -------------------
+    .. autosummary::
+       :toctree: autogen
+       :nosignatures:
+
+       client.Client
+
+    .. comment to end block
+
+    Modules
+    -------
+    .. autosummary::
+       :toctree: autogen
+       :nosignatures:
+
+       client
+
+    .. comment to end block
diff --git a/misc/docs/source/packages/obspy.clients.earthworm.rst b/misc/docs/source/packages/obspy.clients.earthworm.rst
@@ -0,0 +1,24 @@
+.. currentmodule:: obspy.clients.earthworm
+.. automodule:: obspy.clients.earthworm
+
+    .. comment to end block
+
+    Classes & Functions
+    -------------------
+    .. autosummary::
+       :toctree: autogen
+       :nosignatures:
+
+       client.Client
+
+    .. comment to end block
+
+    Modules
+    -------
+    .. autosummary::
+       :toctree: autogen
+       :nosignatures:
+
+       client
+
+    .. comment to end block
diff --git a/misc/docs/source/packages/obspy.fdsn.rst → ...cs/source/packages/obspy.clients.fdsn.rst b/misc/docs/source/packages/obspy.fdsn.rst → ...cs/source/packages/obspy.clients.fdsn.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.fdsn
-.. automodule:: obspy.fdsn
+.. currentmodule:: obspy.clients.fdsn
+.. automodule:: obspy.clients.fdsn
 
     .. comment to end block
 

diff --git a/misc/docs/source/packages/obspy.neic.rst → ...cs/source/packages/obspy.clients.iris.rst b/misc/docs/source/packages/obspy.neic.rst → ...cs/source/packages/obspy.clients.iris.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.neic
-.. automodule:: obspy.neic
+.. currentmodule:: obspy.clients.iris
+.. automodule:: obspy.clients.iris
 
     .. comment to end block
 

diff --git a/.../docs/source/packages/obspy.earthworm.rst → ...cs/source/packages/obspy.clients.neic.rst b/.../docs/source/packages/obspy.earthworm.rst → ...cs/source/packages/obspy.clients.neic.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.earthworm
-.. automodule:: obspy.earthworm
+.. currentmodule:: obspy.clients.neic
+.. automodule:: obspy.clients.neic
 
     .. comment to end block
 
@@ -21,4 +21,4 @@
 
        client
 
-    .. comment to end block
+    .. comment to end block
diff --git a/misc/docs/source/packages/obspy.iris.rst → .../source/packages/obspy.clients.neries.rst b/misc/docs/source/packages/obspy.iris.rst → .../source/packages/obspy.clients.neries.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.iris
-.. automodule:: obspy.iris
+.. currentmodule:: obspy.clients.neries
+.. automodule:: obspy.clients.neries
 
     .. comment to end block
 
@@ -21,4 +21,4 @@
 
        client
 
-    .. comment to end block
+    .. comment to end block
diff --git a/misc/docs/source/packages/obspy.seedlink.rst → ...ource/packages/obspy.clients.seedlink.rst b/misc/docs/source/packages/obspy.seedlink.rst → ...ource/packages/obspy.clients.seedlink.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.seedlink
-.. automodule:: obspy.seedlink
+.. currentmodule:: obspy.clients.seedlink
+.. automodule:: obspy.clients.seedlink
 
     .. comment to end block
 

diff --git a/misc/docs/source/packages/obspy.seishub.rst → ...source/packages/obspy.clients.seishub.rst b/misc/docs/source/packages/obspy.seishub.rst → ...source/packages/obspy.clients.seishub.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.seishub
-.. automodule:: obspy.seishub
+.. currentmodule:: obspy.clients.seishub
+.. automodule:: obspy.clients.seishub
 
     .. comment to end block
 
@@ -24,4 +24,4 @@
 
        client
 
-    .. comment to end block
+    .. comment to end block
diff --git a/misc/docs/source/packages/obspy.station.rst → .../source/packages/obspy.core.inventory.rst b/misc/docs/source/packages/obspy.station.rst → .../source/packages/obspy.core.inventory.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.station
-.. automodule:: obspy.station
+.. currentmodule:: obspy.core.inventory
+.. automodule:: obspy.core.inventory
 
     .. comment to end block
 
@@ -25,6 +25,5 @@
        channel
        response
        util
-       stationxml
 
     .. comment to end block
diff --git a/misc/docs/source/packages/obspy.core.quakeml.rst b/misc/docs/source/packages/obspy.core.quakeml.rst
diff --git a/misc/docs/source/packages/obspy.core.rst b/misc/docs/source/packages/obspy.core.rst
@@ -28,22 +28,8 @@
        stream
        utcdatetime
        event
-       ascii
-       quakeml
+       inventory
        util
        preview
-       json
-
-    .. comment to end block
-
-    Scripts
-    -------
-    .. autosummary::
-      :template: script.rst
-      :toctree: autogen
-      :nosignatures:
-
-        scripts.runtests
-        scripts.reftekrescue
 
     .. comment to end block
diff --git a/misc/docs/source/packages/obspy.core.util.rst b/misc/docs/source/packages/obspy.core.util.rst
@@ -13,11 +13,6 @@
        ~base.NamedTemporaryFile
        ~base.createEmptyDataChunk
        ~base.getExampleFile
-       ~geodetics.calcVincentyInverse
-       ~geodetics.gps2DistAzimuth
-       ~geodetics.kilometer2degrees
-       ~geodetics.locations2degrees
-       ~geodetics.FlinnEngdahl
        ~misc.BAND_CODE
        ~misc.complexifyString
        ~misc.guessDelta
@@ -37,7 +32,6 @@
        attribdict
        base
        decorator
-       geodetics
        misc
        obspy_types
        testing

diff --git a/...ce/packages/obspy.core.util.geodetics.rst → .../docs/source/packages/obspy.geodetics.rst b/...ce/packages/obspy.core.util.geodetics.rst → .../docs/source/packages/obspy.geodetics.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.core.util.geodetics
-.. automodule:: obspy.core.util.geodetics
+.. currentmodule:: obspy.geodetics
+.. automodule:: obspy.geodetics
 
     .. comment to end block
 

diff --git a/misc/docs/source/packages/obspy.nlloc.rst → misc/docs/source/packages/obspy.io.ah.rst b/misc/docs/source/packages/obspy.nlloc.rst → misc/docs/source/packages/obspy.io.ah.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.nlloc
-.. automodule:: obspy.nlloc
+.. currentmodule:: obspy.io.ah
+.. automodule:: obspy.io.ah
 
     .. comment to end block
 

diff --git a/misc/docs/source/packages/obspy.datamark.rst → misc/docs/source/packages/obspy.io.ascii.rst b/misc/docs/source/packages/obspy.datamark.rst → misc/docs/source/packages/obspy.io.ascii.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.datamark
-.. automodule:: obspy.datamark
+.. currentmodule:: obspy.io.ascii
+.. automodule:: obspy.io.ascii
 
     .. comment to end block
 

diff --git a/misc/docs/source/packages/obspy.cnv.rst → misc/docs/source/packages/obspy.io.cnv.rst b/misc/docs/source/packages/obspy.cnv.rst → misc/docs/source/packages/obspy.io.cnv.rst
@@ -1,5 +1,5 @@
-.. currentmodule:: obspy.cnv
-.. automodule:: obspy.cnv
+.. currentmodule:: obspy.io.cnv
+.. automodule:: obspy.io.cnv
 
     .. comment to end block