Documentation update (#296)

* documentation update * update README * remove reqs test
jonathf · Nov 12, 2020 · 1db754c · 1db754c
1 parent 099bb3d
commit 1db754c
Show file tree

Hide file tree

Showing 6 changed files with 206 additions and 273 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -48,10 +48,6 @@ jobs:
       PYTHON_VERSION: 3.8.3
     steps:
       - checkout
-      - run:
-          name: "Ensure requirements.txt and poetry.lock matches"
-          command: |
-            test "$(cat requirements.txt)" = "$(poetry export)"
       - restore_cache:
           keys:
             - deps-py38-{{ checksum "poetry.lock" }}

diff --git a/README.rst b/README.rst
@@ -3,29 +3,28 @@
    :width: 200 px
    :align: center
 
-|circleci| |codecov| |readthedocs| |pypi|
-
-|license| |python-versions| |downloads|
+|circleci| |codecov| |readthedocs| |downloads| |pypi|
 
 .. |circleci| image:: https://img.shields.io/circleci/build/github/jonathf/chaospy/master
     :target: https://circleci.com/gh/jonathf/chaospy/tree/master
 .. |codecov| image:: https://img.shields.io/codecov/c/github/jonathf/chaospy
     :target: https://codecov.io/gh/jonathf/chaospy
 .. |readthedocs| image:: https://img.shields.io/readthedocs/chaospy
-    :target: http://chaospy.readthedocs.io/en/master/?badge=master
+    :target: https://chaospy.readthedocs.io/en/master/?badge=master
+.. |downloads| image:: https://img.shields.io/pypi/dm/chaospy
+    :target: https://pypistats.org/packages/chaospy
 .. |pypi| image:: https://img.shields.io/pypi/v/chaospy
     :target: https://pypi.org/project/chaospy
-.. |license| image:: https://img.shields.io/pypi/l/chaospy
-    :target: https://opensource.org/licenses/MIT
-.. |python-versions| image:: https://img.shields.io/pypi/pyversions/chaospy
-.. |downloads| image:: https://img.shields.io/pypi/dw/chaospy
-    :target: https://pypistats.org/packages/chaospy
 
 Chaospy is a numerical tool for performing uncertainty quantification using
 polynomial chaos expansions and advanced Monte Carlo methods implemented in
 Python.
 
-.. contents:: Table of Contents:
+* Documentation: https://chaospy.readthedocs.io/en/master
+* Source code: https://github.com/jonathf/chaospy
+* Issues: https://github.com/jonathf/chaospy/issues
+* Journal article: `"Chaospy: An open source tool for designing methods of
+  uncertainty quantification" <http://dx.doi.org/10.1016/j.jocs.2015.08.008>`_
 
 Installation
 ------------
@@ -101,11 +100,36 @@ For a more extensive guides on what is going on, see the `tutorial collection`_.
 
 .. _tutorial collection: https://chaospy.readthedocs.io/en/master/tutorials
 
-Related Projects
-----------------
+Contributions and Related Projects
+----------------------------------
+
+A few shout-outs to people who have contributed to the Chaospy project:
+
++--------------+--------------------------------------------------------------+
+| `OpenTURNS`_ | Thanks to `Régis Lebrun`_ for both proposing a collaboration |
+|              | and creating an initial implementation of both               |
+|              | `Chaospy Compatibility`_ in `OpenTURNS`_ and                 |
+|              | `OpenTURNS Compatibility`_ in ``chaospy``.                   |
++--------------+--------------------------------------------------------------+
+| `orthopy`_   | Thanks to `Nico Schlömer`_ for providing the implementation  |
+| `quadpy`_    | for several of the quadrature integration methods.           |
++--------------+--------------------------------------------------------------+
+| ``UQRF``     | Thanks to `Florian Künzner`_ for providing the initial       |
+|              | implementation of kernel density estimation and              |
+|              | quantity-of-interest distribution.                           |
++--------------+--------------------------------------------------------------+
+
+.. _OpenTURNS: http://openturns.github.io/openturns/latest
+.. _Régis Lebrun: https://github.com/regislebrun
+.. _Chaospy Compatibility: http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.ChaospyDistribution.html
+.. _OpenTURNS Compatibility: https://chaospy.readthedocs.io/en/master/recipes/external.html#module-chaospy.external.openturns_
+.. _orthopy: https://github.com/nschloe/orthopy
+.. _quadpy: https://github.com/nschloe/quadpy
+.. _Nico Schlömer: https://github.com/nschloe
+.. _Florian Künzner: https://github.com/flo2k
 
 Chaospy is being used in other related projects that requires uncertainty
-quantification components ``chaospy`` provides.
+quantification components ``chaospy`` provides. For example:
 
 +-----------------+-----------------------------------------------------------+
 | `easyVVUQ`_     | Library designed to facilitate verification, validation   |
@@ -130,31 +154,8 @@ quantification components ``chaospy`` provides.
 .. _UncertainPy: https://github.com/simetenn/uncertainpy
 .. _SparseSpACE: https://github.com/obersteiner/sparseSpACE
 
-Also a few shout-outs:
-
-+--------------+--------------------------------------------------------------+
-| `OpenTURNS`_ | Thanks to `Régis Lebrun`_ for both proposing a collaboration |
-|              | and creating an initial implementation of both               |
-|              | `Chaospy Compatibility`_ in `OpenTURNS`_ and                 |
-|              | `OpenTURNS Compatibility`_ in ``chaospy``.                   |
-+--------------+--------------------------------------------------------------+
-| `orthopy`_   | Thanks to `Nico Schlömer`_ for providing the implementation  |
-| `quadpy`_    | for several of the quadrature integration methods.           |
-+--------------+--------------------------------------------------------------+
-| ``UQRF``     | Thanks to `Florian Künzner`_ for providing the initial       |
-|              | implementation of kernel density estimation and              |
-|              | quantity-of-interest distribution.                           |
-+--------------+--------------------------------------------------------------+
-
-.. _OpenTURNS: http://openturns.github.io/openturns/latest
-.. _Régis Lebrun: https://github.com/regislebrun
-.. _Chaospy Compatibility: http://openturns.github.io/openturns/latest/user_manual/_generated/openturns.ChaospyDistribution.html
-.. _OpenTURNS Compatibility: https://chaospy.readthedocs.io/en/master/recipes/external.html#module-chaospy.external.openturns_
-.. _orthopy: https://github.com/nschloe/orthopy
-.. _quadpy: https://github.com/nschloe/quadpy
-.. _Nico Schlömer: https://github.com/nschloe
-.. _Florian Künzner: https://github.com/flo2k
-.. _sample distribution: https://chaospy.readthedocs.io/en/master/recipes/external.html#module-chaospy.external.samples
+For a more comprehensive list, see `Github's dependency graph
+<https://github.com/jonathf/chaospy/network/dependents>`_.
 
 Questions and Contributions
 ---------------------------

diff --git a/docs/conf.py b/docs/conf.py
@@ -15,8 +15,9 @@
 
 # -- Project information -----------------------------------------------------
 
+import time
 project = 'ChaosPy'
-copyright = '2019, Jonathan Feinberg'
+copyright = '%d, Jonathan Feinberg' % time.gmtime().tm_year
 author = 'Jonathan Feinberg'
 
 # -- General configuration ---------------------------------------------------
@@ -76,14 +77,16 @@
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-#
-html_theme = 'alabaster'
+html_theme = "alabaster"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 
 html_theme_options = {
+    "badge_branch": "master",
+    "codecov_button": True,
+    "fixed_sidebar": True,
     "github_user": "jonathf",
     "github_repo": "chaospy",
     "github_banner": True,
@@ -92,6 +95,8 @@
     "logo_text_align": "center",
     "description": ("Uncertainty quantification with polynomial chaos "
                     "expansions and advanced Monte Carlo integration"),
+    "show_powered_by": False,
+    "show_relbars": True,
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

diff --git a/docs/tutorials/introduction/monte_carlo_integration.ipynb b/docs/tutorials/introduction/monte_carlo_integration.ipynb
diff --git a/docs/tutorials/introduction/point_collocation.ipynb b/docs/tutorials/introduction/point_collocation.ipynb
diff --git a/requirements.txt b/requirements.txt
@@ -1,104 +1,5 @@
-functools32==3.2.3-2; python_version >= "2.7" and python_version < "3.0" and (python_version >= "2.7" and python_version < "3.0" or python_version < "3") \
-    --hash=sha256:f6253dfbe0538ad2e387bd8fdfd9293c925d63553f5813c4e587745416501e6d \
-    --hash=sha256:89d824aa6c358c421a234d7f9ee0bd75933a67c29588ce50aaa3acdf4d403fa0
-numpoly==1.0.8 \
-    --hash=sha256:5a8a71fae66e941b0b023c00c75cb5002e6a0f5294f0127740cb8bb46dcecfb1 \
-    --hash=sha256:a652dda077c9a3e73887e5f918077d541eebb89b90f36cf148df0f4246cd5943
-numpy==1.16.6; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.4.0") \
-    --hash=sha256:08bf4f66f190822f4642e036accde8da810b87fffc0b9409e7a00d9e54760099 \
-    --hash=sha256:d759ca1b76ac6f6b6159fb74984126035feb1dee9f68b4b961889b6dc090f33a \
-    --hash=sha256:d3c5377c6122de876e695937ef41ffee5d2831154c5e4856481b93406cdfeecb \
-    --hash=sha256:345b1748e6b0d4773a518868c783b16fdc33a22683bdb863484cd29fe8d206e6 \
-    --hash=sha256:7a5a1f49a643aa1ab3e0579da0a48b8a48ea4369eb63c5065459d0a37f430237 \
-    --hash=sha256:817eed5a6ec2fc9c1a0ee3fbf9a441c66b6766383580513ccbdf3121acc0b4fb \
-    --hash=sha256:1680c8d5086a88d293dfd1a10b6429a09140cacee878034fa2308472ec835db4 \
-    --hash=sha256:a4383edb1b8caa989c3541a37ef204916322c503b8eeacc7ee8f4ba24cac97b8 \
-    --hash=sha256:9bb690692f3101583b0b99f3be362742e4f8ebe6c7934fa36cd8ca2b567a0bcc \
-    --hash=sha256:b9e334568ca1bf56598eddfac6db6a75bcf1c91aa90d598648f21e45207daeae \
-    --hash=sha256:55cae40d2024c56e7b79fb070106cb4289dcc6b55c62dba1d89a6944448c6a53 \
-    --hash=sha256:a1ffc9c770ccc2be9284310a3726c918b26ca19b34c0079e7a41aba950ab175f \
-    --hash=sha256:3f423b06bf67cd1dbf72e13e9b53a9ca71972e5abf712ee6cb5d8cbb178fff02 \
-    --hash=sha256:34e6bb44e3d9a663f903b8c297ede865b4dff039aa43cc9a0b249e02c27f1396 \
-    --hash=sha256:60c56922c9d759d664078fbef94132377ef1498ab27dd3d0cc7a21b346e68c06 \
-    --hash=sha256:23cad5e5858dfb73c0e5bce03fe78e5e5908c22263156c58d4afdbb240683c6c \
-    --hash=sha256:77399828d96cca386bfba453025c34f22569909d90332b961d3d4341cdb46a84 \
-    --hash=sha256:97ddfa7688295d460ee48a4d76337e9fdd2506d9d1d0eee7f0348b42b430da4c \
-    --hash=sha256:390f6e14a8d73591f086680464aa101a9be9187d0c633f48c98b429b31b712c2 \
-    --hash=sha256:a1772dc227e3e415eeaa646d25690dc854bddc3d626e454c7c27acba060cb900 \
-    --hash=sha256:c9fb4fcfcdcaccfe2c4e1f9e0133ed59df5df2aa3655f3d391887e892b0a784c \
-    --hash=sha256:6b1853364775edb85ceb0f7f8214d9e993d4d1d9bd3310eae80529ea14ba2ba6 \
-    --hash=sha256:e5cf3fdf13401885e8eea8170624ec96225e2174eb0c611c6f26dd33b489e3ff \
-    --hash=sha256:e91d31b34fc7c2c8f756b4e902f901f856ae53a93399368d9a0dc7be17ed2ca0 \
-    --hash=sha256:7d42ab8cedd175b5ebcb39b5208b25ba104842489ed59fbb29356f671ac93583 \
-    --hash=sha256:a78e438db8ec26d5d9d0e584b27ef25c7afa5a182d1bf4d05e313d2d6d515271 \
-    --hash=sha256:a87f59508c2b7ceb8631c20630118cc546f1f815e034193dc72390db038a5cb3 \
-    --hash=sha256:965df25449305092b23d5145b9bdaeb0149b6e41a77a7d728b1644b3c99277c1 \
-    --hash=sha256:ac792b385d81151bae2a5a8adb2b88261ceb4976dbfaaad9ce3a200e036753dc \
-    --hash=sha256:ef627986941b5edd1ed74ba89ca43196ed197f1a206a3f18cc9faf2fb84fd675 \
-    --hash=sha256:f718a7949d1c4f622ff548c572e0c03440b49b9531ff00e4ed5738b459f011e8 \
-    --hash=sha256:4064f53d4cce69e9ac613256dc2162e56f20a4e2d2086b1956dd2fcf77b7fac5 \
-    --hash=sha256:b03b2c0badeb606d1232e5f78852c102c0a7989d3a534b3129e7856a52f3d161 \
-    --hash=sha256:a7acefddf994af1aeba05bbbafe4ba983a187079f125146dc5859e6d817df824 \
-    --hash=sha256:cd49930af1d1e49a812d987c2620ee63965b619257bd76eaaa95870ca08837cf \
-    --hash=sha256:b39321f1a74d1f9183bf1638a745b4fd6fe80efbb1f6b32b932a588b4bc7695f \
-    --hash=sha256:cae14a01a159b1ed91a324722d746523ec757357260c6804d11d6147a9e53e3f \
-    --hash=sha256:0172304e7d8d40e9e49553901903dc5f5a49a703363ed756796f5808a06fc233 \
-    --hash=sha256:e15b382603c58f24265c9c931c9a45eebf44fe2e6b4eaedbb0d025ab3255228b \
-    --hash=sha256:3676abe3d621fc467c4c1469ee11e395c82b2d6b5463a9454e37fe9da07cd0d7 \
-    --hash=sha256:4674f7d27a6c1c52a4d1aa5f0881f1eff840d2206989bae6acb1c7668c02ebfb \
-    --hash=sha256:9c9d6531bc1886454f44aa8f809268bc481295cf9740827254f53c30104f074a \
-    --hash=sha256:3dd6823d3e04b5f223e3e265b4a1eae15f104f4366edd409e5a5e413a98f911f \
-    --hash=sha256:34e96e9dae65c4839bd80012023aadd6ee2ccb73ce7fdf3074c62f301e63120b
-scipy==1.2.3; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.4.0") \
-    --hash=sha256:2ff82db1393bd5d8ddeb9134e8f77a8e971e635452d7e65f7238f40c71d385a8 \
-    --hash=sha256:5d950892a6a2da6dae2b5a3021b329dbf04483a7fb0bd3011685db7f51578ae7 \
-    --hash=sha256:487a61a7e477923c7a9e8fa06f27e3f2dbc7ce9450a970a2e5d902b0a305d028 \
-    --hash=sha256:3397ce30e240e9a543d81f623a9e8e98ae39012cf72e42e95929530a03f20791 \
-    --hash=sha256:8533e8c2e467eed913a0aa4fac09c9fb824f32d1ab1121db3a50845f9b347825 \
-    --hash=sha256:b6cbb7125b0c742e0f31fb293d19e9f1a03db58f6ddefc51a2025ee15ae607cb \
-    --hash=sha256:e870dfd006ab657f9cc48b099646c5ceb4e812e59a7d460dc80ac9a659f089dc \
-    --hash=sha256:b8b0e81a2b87d68acf4a54aea800edafbb5bc9a04f38256718826f95f625fb75 \
-    --hash=sha256:ecc27dda36d7172bb4ed7f245499e28251fa17909b314b4e8956a942f302e1a3 \
-    --hash=sha256:ee213d8c8eee0540ba91efca61605dc0e2b5bd90ca35ab49c85f0ad7038df00f \
-    --hash=sha256:57a0ee083b94944ba6329e755d112bfd53a98bd9a6a4faf10bc7722c955a7653 \
-    --hash=sha256:1bc0720f149fbb69d19156cf91730aa21455c58949aea56bfaa2b74c06868100 \
-    --hash=sha256:d39ae9cfd7bdea7753fd617e2edfc68b94a019a65c0153c3fced35cf657b79e7 \
-    --hash=sha256:7e6c485c3f2789c790fe4cc5c6c3b4554000d284fd05be90479b6fbd8795d064 \
-    --hash=sha256:92fbdcf9acebf2007502adbed1b22e3a3e9445aceb5e7a568f9759d76461368b \
-    --hash=sha256:b2fad2430232f8c2faeb0abff7ed5191f0a534bd1bd482c71a9616c44e674c76 \
-    --hash=sha256:8b3ac1e50188792fdf811e5a747df2b784c65d9a17f59609a73c8285424a48ad \
-    --hash=sha256:b38f2e6d53f852ae1de1aacead2c26a69c91b36f833e744557ca370979b81652 \
-    --hash=sha256:39bf06b2536e69f08a257b260aaa25d088d755b73cf3751b44e5838ccb1d0a82 \
-    --hash=sha256:c08013e0fe1554372da9312d5bad588402f71c0636f0f86a9b9b61d507c59bac \
-    --hash=sha256:cac83647970115dfb6d29dc3b4ab44b3aa11254e8aeba115f88ad0ccbb273085 \
-    --hash=sha256:0c23e5b3a314dce4049b969c81ad801cf05e1fe699760846c7567deaa9b8c548 \
-    --hash=sha256:503e25b8da22b1be6f2f81e1dcf26f42bfb13fe89bccbf8bc48e1b6f2a4789c8 \
-    --hash=sha256:19904399501ecf56ead21b307cc52c8ff03a2103343f554f3fbc189bb2cf1609 \
-    --hash=sha256:f658f90db1530f70128bbeb2c1e61006de2eb2382408080a211d885f501af3a7 \
-    --hash=sha256:7aeb232273b38e74d89181d9165ca47314e1c4269afe7c3a1926aea3e63345a2 \
-    --hash=sha256:53353a504ad2181eb27c9d61e91ce29324f8b7550876736a08a36e6b60c43407 \
-    --hash=sha256:ecbe6413ca90b8e19f8475bfa303ac001e81b04ec600d17fa7f816271f7cca57 \
-    --hash=sha256:c5cac0c0387272ee0e789e94a570ac51deb01c796b37fb2aad1fb13f85e2f97d \
-    --hash=sha256:a144811318853a23d32a07bc7fd5561ff0cac5da643d96ed94a4ffe967d89672 \
-    --hash=sha256:71eb180f22c49066f25d6df16f8709f215723317cc951d99e54dc88020ea57be \
-    --hash=sha256:770254a280d741dd3436919d47e35712fb081a6ff8bafc0f319382b954b77802 \
-    --hash=sha256:a1aae70d52d0b074d8121333bc807a485f9f1e6a69742010b33780df2e60cfe0 \
-    --hash=sha256:bb517872058a1f087c4528e7429b4a44533a902644987e7b2fe35ecc223bc408 \
-    --hash=sha256:dba8306f6da99e37ea08c08fef6e274b5bf8567bb094d1dbe86a20e532aca088 \
-    --hash=sha256:386086e2972ed2db17cebf88610aab7d7f6e2c0ca30042dc9a89cf18dcc363fa \
-    --hash=sha256:8d3bc3993b8e4be7eade6dcc6fd59a412d96d3a33fa42b0fa45dc9e24495ede9 \
-    --hash=sha256:dc60bb302f48acf6da8ca4444cfa17d52c63c5415302a9ee77b3b21618090521 \
-    --hash=sha256:787cc50cab3020a865640aba3485e9fbd161d4d3b0d03a967df1a2881320512d \
-    --hash=sha256:0902a620a381f101e184a958459b36d3ee50f5effd186db76e131cbefcbb96f7 \
-    --hash=sha256:00af72998a46c25bdb5824d2b729e7dabec0c765f9deb0b504f928591f5ff9d4 \
-    --hash=sha256:9508a7c628a165c2c835f2497837bf6ac80eb25291055f56c129df3c943cbaf8 \
-    --hash=sha256:a2d6df9eb074af7f08866598e4ef068a2b310d98f87dc23bd1b90ec7bdcec802 \
-    --hash=sha256:3092857f36b690a321a662fe5496cb816a7f4eecd875e1d36793d92d3f884073 \
-    --hash=sha256:8a07760d5c7f3a92e440ad3aedcc98891e915ce857664282ae3c0220f3301eb6 \
-    --hash=sha256:1e3190466d669d658233e8a583b854f6386dd62d655539b77b3fa25bfb2abb70 \
-    --hash=sha256:cc971a82ea1170e677443108703a2ec9ff0f70752258d0e9f5433d00dda01f59 \
-    --hash=sha256:2cce3f9847a1a51019e8c5b47620da93950e58ebc611f13e0d11f4980ca5fecb \
-    --hash=sha256:dee1bbf3a6c8f73b6b218cb28eed8dd13347ea2f87d572ce19b289d6fd3fbc59
-six==1.15.0; python_version >= "2.7" and python_full_version < "3.0.0" or python_full_version >= "3.3.0" \
-    --hash=sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced \
-    --hash=sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259
+functools32==3.2.3-2; python_version >= "2.7" and python_version < "3.0" and (python_version >= "2.7" and python_version < "3.0" or python_version < "3")
+numpoly==1.0.8
+numpy==1.16.6; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.4.0")
+scipy==1.2.3; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.4.0")
+six==1.15.0; (python_version >= "2.7" and python_full_version < "3.0.0") or (python_full_version >= "3.3.0")