Gallery setup (josephhardinee#52)

* Added travis CI files needed to auto-generate docs
* Added Gallery Support

.travis.yml

@@ -1,45 +1,47 @@
 sudo: false
 env:
-    global:
-        - LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libgfortran.so.3
+  global:
+  - LD_PRELOAD=/usr/lib/x86_64-linux-gnu/libgfortran.so.3
+  - secure: "HC56kqcyplnfsHFZpM122GVdG8j0b6M1uexIJKVCpy8YS6u7ooS8Oh9jp6OxDyg47OtGJGRPeGvQJ2bMuKhbNz+3YHNxf08AJVApwPq+25PpfGedMWMgmZI42zAzN6RYVUDjYEZb3Y52j4Kw8UaFwfdxoPVFhTiRCgr054laZFc="
 addons:
-    apt:
-        packages:
-            - gfortran
+  apt:
+    packages:
+    - gfortran
 language: python
-
 matrix:
   include:
-      - python: "2.7"
-        env: 
-        - PYTHON_VERSION="2.7"
-        - NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
-        - COVERALLS="true"
-      - python: "3.4"
-        env: 
-        - PYTHON_VERSION="3.4"
-        - NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
-        - COVERALLS="true"
-      - python: "3.5"
-        env: 
-        - PYTHON_VERSION="3.5"
-        - NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
-        - COVERALLS="true"
-      - python: "3.6"
-        env: 
-        - PYTHON_VERSION="3.6"
-        - NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
-        - COVERALLS="true"
-
-
-
+  - python: '2.7'
+    env:
+    - PYTHON_VERSION="2.7"
+    - NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
+    - COVERALLS="true"
+  - python: '3.4'
+    env:
+    - PYTHON_VERSION="3.4"
+    - NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
+    - COVERALLS="true"
+  - python: '3.5'
+    env:
+    - PYTHON_VERSION="3.5"
+    - NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
+    - COVERALLS="true"
+  - python: '3.6'
+    env:
+    - PYTHON_VERSION="3.6"
+    - NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
+    - COVERALLS="true"
+  - python: '3.6'
+    env:
+    - PYTHON_VERSION="3.6"
+    - NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
+    - COVERALLS="true"
+    - DOC_BUILD="true"
 before_install:
-    - pip install pytest pytest-cov
-    - pip install coveralls
-
+- pip install pytest pytest-cov
+- pip install coveralls
 install: source continuous_integration/install.sh
-
 script: eval xvfb-run nosetests $NOSE_ARGS
-
 after_success:
-    - coveralls
+- coveralls
+- if [[ "$DOC_BUILD" == "true" ]]; then cd $TRAVIS_BUILD_DIR; source continuous_integration/build_docs.sh;
+  fi

continuous_integration/build_docs.sh

@@ -0,0 +1,6 @@
+set -e
+pip install doctr pillow
+cd docs
+make html
+cd ..
+doctr deploy .

continuous_integration/install.sh

@@ -31,6 +31,7 @@ source activate testenv
 # Install dependencies
 conda install --yes numpy scipy matplotlib netcdf4 nose sphinx numpydoc hdf4=4.2.12
 conda install --yes sphinx_rtd_theme
+pip install sphinx-gallery
 
 
 pip install git+https://github.com/jleinonen/pytmatrix.git

docs/source/conf.py

@@ -39,8 +39,13 @@
     'sphinx.ext.ifconfig',
     'sphinx.ext.viewcode',
     'numpydoc',
+    'sphinx_gallery.gen_gallery'
 ]
 
+sphinx_gallery_conf = {
+    'examples_dirs': '../../examples',
+    'gallery_dirs': 'source/auto_examples'
+}
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 

docs/source/index.rst

@@ -9,7 +9,9 @@ Welcome to PyDisdrometer's documentation!
 Contents:
 
 .. toctree::
-   :maxdepth: 2
+   :maxdepth: 1
+
+   auto_examples/index
 
    pydisdrometer.rst
    pydisdrometer.aux_readers.rst

docs/source/pydisdrometer.rst

@@ -39,23 +39,23 @@ DropSizeDistribution module
 JWDReader module
 ------------------------------
 
-.. automodule:: pydisdrometer.JWDReader
+.. automodule:: pydisdrometer.io.JWDReader
     :members:
     :undoc-members:
     :show-inheritance:
 
 ParsivelNasaGVReader module
 -----------------------------------------
 
-.. automodule:: pydisdrometer.ParsivelNasaGVReader
+.. automodule:: pydisdrometer.io.ParsivelNasaGVReader
     :members:
     :undoc-members:
     :show-inheritance:
 
 ParsivelReader module
 -----------------------------------
 
-.. automodule:: pydisdrometer.ParsivelReader
+.. automodule:: pydisdrometer.io.ParsivelReader
     :members:
     :undoc-members:
     :show-inheritance:
@@ -71,15 +71,7 @@ UtilityDisplay module
 expfit module
 ---------------------------
 
-.. automodule:: pydisdrometer.expfit
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
-process_NASA_APU module
--------------------------------------
-
-.. automodule:: pydisdrometer.process_NASA_APU
+.. automodule:: pydisdrometer.utility.expfit
     :members:
     :undoc-members:
     :show-inheritance:

examples/README.txt

@@ -0,0 +1,4 @@
+PyDisdrometer Example Gallery
+-----------------------------
+
+PyDisdrometer Example Gallery.

examples/plot_basic_example.py

@@ -0,0 +1,24 @@
+"""
+Simple Example
+--------------
+
+A simple example using PyDisdrometer. This example reads in a OTT APU Disdrometer file, calculates the radar variables, and plots a few of them.
+Author: Joseph C. Hardin
+"""
+
+import numpy as np
+import matplotlib.pyplot as plt
+
+import pydisdrometer as pyd
+
+
+filename = '../testdata/sgpdisdrometerC1.b1.20110427.000000_test_jwd_b1.cdf'
+dsd = pyd.aux_readers.ARM_JWD_Reader.read_arm_jwd_b1(filename)
+#Read in the Parsivel File
+fig = plt.figure(figsize=(8,8))
+plt.plot(dsd.fields['Nd']['data'][0])
+
+plt.show()
+
+
+

github_deploy_key.enc

@@ -0,0 +1 @@
+gAAAAABZEXC5ptLv2EA1JmT071Kox6mmjLG7VFjFExw1gAfkAWD5OqVFP5MCMGIsQJPgdkE7G2ZTlUvVKit3vTf0STxCLseGRLNrweqUMLPMrYpl-HIYzqdOvlFRyu7FdQWcHjYUie_Sax8rQvt2xKKGDh6cudOaEtY16ZobLMZF7gYUfLufpGmwOs605asEVb5KnEOoS8ctE7pTcuOLW6jwY2Uda8SoYZhc11N0ibh6rFOEMn2jWzBlfbpxk-zRwVX7RWl_XU2RsKIzcy2pzyxn184Zc3bN0QMiv75jojluJl2wYHEmFBphkE4PtQ9_s3fgafUXVIrd0UNCTq8OMPc5PtqVThufQiReXhsPSmhV9VWs6koIE8Sdv8gjiJup-muNu4yHf87_DA9frsp2sOmLz8t4OX8xgN-y9nsglkJP1-SL65NWJ_3x_oREEwMCaMZpPtOu1t62tHJBQGX8Ez2ZiH9ZeGhvGtZnvo-JSnpge4HleW7O8MYIM2fOAmaYY8jdRLVCG7AebjAiNjoABQXETdXjlW23eZNivpnQTvHh0P4Zpo4SsDbmwDFAi63qJYnZ2vdfPOUfsmK2LBWCyAdGg8V_eS0bvG3HgO6jhBga24RHJk2FHSgWYbVJOP1FsNYE8Eu_wM1-AVpty_Rao4DUvUEgiliEBVDnSC4aYaKh8WzW4RS8oiN20qyTVULb6fAG_5jp2DglbQB8HE8pn_mJPaHYtEc67yg4p2kkhD8TrNZkrV6_WNu68etpjpVb3Ju0mMfKxmDvFRdJEANDcwZCzrlUD0lu_LBBjt_0fiLEjxGvbzqVl_5OFEN_AO1qVpA6YawRXSpl76cbiPOJS_wFtjcstBeP4hczhEMFM8CYa4OuPvpvZPbJlz6TzqhslkQ5BXdt3R6KqpeHrpD0TSdj9w3F6A2hUYMZzHb9CcqhdXMTXd6TXTl3mJvF5XoSQksCj6DZwmFWG9xnZg7_SamNyJiTg4KA6zKpVFbUQh_Yvr-1MeVTV8Dq-wRV8bL6vBogq9-Y06Nv9vaCB1Gdg3BTqcdOQe-vLUAWH97D83xmvda2EtUtfOiOXBQrDzhDHNzaPzYLlmKQEGI6cKdGIikOArGNuOHfqA76TFkifuOtg9_SUh4PorbUTthxfPmDSGSLd28-hfqq_15gRmXv8mlWqeQqIIs729CVX3N6XgpLYaxacohSw0d6dcXqNJBfo1nbEIs-CxksC4I1amjcpEefq-wij__MWm9q5eFVXKAoPmkMK4K7_tj_slNknijTSjH2iLhf9AX2vNz7fULPmcFnzg_ZaEV0CT1MhBjaSj0rEnYsieX0s0IX59cmrbcUMYwwLxTB536ZSK20BVcHqHhOZWJciHlAek5JZO5JJsms_N3JOEOMgg9E11pkjtOuZBwiPL9zyiM5csyZ1kuYQ9d_pWHY-qDumHzQ_SQkWESS-exBDM4rqps6dl_6w6T7OAIumpqlcpyvzLCBn27GRAAUcISKhjZLlBAy-6mm7JlVGQqCNy03yv5jOr0HzrbjJXNuJHWBMwN75JxgKGm5G5T-bj6kzoM1u-baCoGVqFGFVPiZha72ppKkH0xAx3gG3qpC9IzuLey6smB-nXWUGEVNWdi-k-JvWhYbDBiIfpXoyQBUX2yL7k1F9B1L55-_9w0OAKVuP3S5-dEjscq1YACu-_yx_69XN8Hz5mCkff1uWCIO-KtT0YDilIiO8ioH2pz6A5GbpWUsGG8Br7l5u1X3PXI46Z7ZKBXdDIqiSh05tesb3HgEzhpIp7Cf3VQi6QU-BCnv-xYmkqqNa4gYwC0OH2fvpi8fdTdn0OmQU1dj0sflm7BY7MA3TkIKozplm0d1m3lkaOmxtz7hTMbICBybbdy4EcOskhwpGS7BrXDjRjBzWmrO-y0TniT06cdWrL2GtMH-mBWbNVnf9mAtW89RwLUo6QwHmIENKfznwXRwWbKE_PD_MwsHTf8hDOmbfRgmWND0WrWhNZXMk4FNOZGnbDG0EukKSQRrSkiQBrElqOoflHmW7W-cgy8n8WbtosutVPI79CzaX9v8-FXymgTTgQJ7s7_lUs3bXWWzn9IoUJqvTxQhhHMufDFeCGVKZvTLsf8QUTHZLsJECJ_WOksFHD4ntUe5S9jgBoLFofCZ5bUIdZz45QIaFoWtoYEfEO3UIqks8ghG96K9yxf1BZ59orgMaAWo2CP2fF2wYIYAHV3ceTdSKm01qvR66cQDM_g1fDvuOwxV9jHFluMLSwXgJQLClq58gNX3boayofetA9JvFPkBzNlZtvp0dd8bqlvbuRs3dStTP2RFSijWqm2ok4GsNZJ2MkX3wSLAqmCu4pgGyloh3E_BqVWc2CvbTN41EJz1V15EwrpeAOHbNkBudF72M54VxtuJc40n0gkVmiM7VY3m_DFjYh9aVW3u4KX42posPDhnbLqQviCMEc_ERoMLn468Du85kMuMN9mrYR5kVxuRqibpAfGipoOfvs1LV0uU6CAf-LZjjkbh4DtvCxi2tKcVSmRYrMGJ-q9KqaxFilMt3R8hyQTGaEcBSQOxvx8xaaYA16mDIDWWVNpojAJ_GgL4UT-eTSbjbPtpMYPyg0ZknYLk-7Fsa_BT4sGIim8IBoxR6l1b2_-A5EOAZ4ceOsyznPrD_Ok0fZSywMEHquDjSC49I_tKjpZbHCRQrm6m0eL911RzXFmZYFfDfwSDsymDjGr5FKr2mCSkRxPCbQ5joamMnYRn0V4bn2df09rLyJYt6N-sNutsBLDqbICQkWZz7yWkWfNi2ZMCb2NTHvgrpcgKUcjCUl7q8InKfWIYbdKa450AkKrg-f_BJTJ_WlfWOsoiQZdjd5ZVTE9LXHOP9HA5y5xAWLf6YDsVEqvTwsUG4_pLnnYY-e_HzF2nh8lZqCr7ibhDEdiwQCH_O_JDV_u7vAPLg1VgDDqvWDCUcN_Kj8jZ5lsR8nGxQPNM7rgSi3jxR8FfmMJcak7kMUepEq13VKhIWLmrO4M__XEfomYwUOURODq9y9kcPhwt6eD76yviZumTUFtBlyyOKwoy5Us-aVoAHt8x79NBjefo6CS6CNBESO-_Z0D3WMs56iVf3A99y8CXb1bY8tQGJb_XYGyhG9z_3SkAZB7UtqbAdSDOlTxkJWL91A4o0S_vkkEQMnLKb7u-RwGKlWKrAYNa29QD27OMX_Vy6StsVv5UCPUfBifc_fBctq5qb7PicRsS9PPBmqmgw90JO1JtEBUmbV3M6-sEXXFMTCXSzYvugy6MY8N_OYdOVrf4XltPWdkGlz_jdQXSphgEeU79Bnvo8qcFngZvqMza95dhBjyfNtwFGgQ77iEjJJLfDE28KOY53aI4qcqC6_-BQ5V0eQgBQhFr7mR1SPKVnFtbeRHWg21OJFjym1hzUvit8_vNvSHZO8gPKqTMECKJ5yf_2UtZpq3IWdcKMu_Ygu1FERPKlAU6JId7yv1IqDGI3zRbwNfW9aI_OSeTWc1MfT9noBYElsHWKkNK1cZBzplPvdXZ2sb2z0mEIkx8NCAE5DUYj-Yvs130bHyTKsCaEAjClUud35thEi0JR2hqURFCQn-EkOVvcMQqUCDKL3hntPk-EhqGdei-ZJLpNKUObEzf4_INRS3lc6a1TJ-UYUW4RUWzxq6ipoQAgZc43nixKGitCUIhwxhvGqo-1nTFMKByohmTZoPQCTJpXFtexSeBp1aTSHrtyJbQtNRxOewCgvTWO--YRfPI1hhQrq7X7zEXTzlbIh9TVMmJF6Mrm0SHUMdeRgGM2SSnL8PHqDe6vATUBJQQmERWNfkNUJ7K0xQLmT53cEn0QXXmiy90gIjT20ilD7_resH8cl0KZVZrxjY5viw5i2-E3Sfa6tqgblbRMLiBpwzWkhxSMs6l-tsmjRgTLFOssYgz0WBbOVwfla7r3Syfpn3ljrPyLqpinSebLaVtUoqfIAzIHWwaYzPfx5NSlKHMmoIPg6l_vpcwuecmE-lTnc2TjPzNa2ixYVbFd5axO6aCiK1VgjidSmDWvfsG6fKDUbMg3LdRFYGpTByg9mbqyC6im4-fSKGBsXZEsb9L_lz5bjt04FajxepynB8gwTsj2w9DQ26N-VVfQQMimow9QAANefQBjr3rk3Ix905t1Id0wlE7vkyS7eOpR9SeEu0YP0dXNKDolKq9hv1Vnv4Fbqil0ynffUqJdpchMsIYa25-SQAf-1O5N3-MBwWe2UbrziGv1AVXXhd3SR_dPqJ_CNsnDGXZvNnA9hOx-LvAOv6PRHyBuTTMQA8ZdUglfiayS4GA3xlm69c4hu1OkiO4UUOKEX522y9ZhHOPq02QugGFS5ro9cZAd2flRUIE49kgdZI4ZEvxz3C5ig8MquPvN6E_wzLa5JfsgBIFmWxOowA=