Merge branch 'master' of ssh://github.com/zingale/pyro2

Author: zingale

CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+
+Contributions are welcomed from anyone, including posting issues or
+submitting pull requests to the [pyro github](https://github.com/zingale/pyro).
+
+## Issues
+
+Creating an issue on github is a good way to request new features,
+file a bug report, or notify us of any difficulties that arise using
+pyro.
+
+To request support using pyro, please create an issue on the pyro
+github and the developers will be happy to assist you.
+
+If you are reporting a bug, please indicate any information necessary
+to reproduce the bug including your version of python.
+
+## Pull Requests
+
+*Any contributions that have the potential to change answers should be
+done via pull requests.* A pull request should be generated from your
+fork of pyro and target the `master` branch.
+
+The unit and regression tests will run automatically once the PR is
+submitted, and then one of the pyro developers will review the PR and
+if needed, suggest modifications prior to merging the PR.
+
+If there are a number of small commits making up the PR, we may wish
+to squash commits upon merge to have a clean history.  *Please ensure
+that your PR title and first post are descriptive, since these will be
+used for a squashed commit message.*

DEVELOPMENT

@@ -14,7 +14,7 @@ To support notebooks:
 
 pip3 install nbsphinx --user
 dnf install pandoc
-
+dnf install python3-ipython-sphinx
 
 For numpy doc format:
 

docs/notes.txt

@@ -39,6 +39,7 @@
     'sphinx.ext.autosummary',
     'nbsphinx',
     'numpydoc',
+    'IPython.sphinxext.ipython_console_highlighting',
     'sphinx.ext.githubpages']
 
 # Add any paths that contain templates here, relative to this directory.
@@ -66,9 +67,9 @@
 # built documents.
 #
 # The short X.Y version.
-version = '2.1'
+version = '2.2'
 # The full version, including alpha/beta/rc tags.
-release = '2.1'
+release = '2.2'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

docs/source/conf.py

@@ -14,6 +14,7 @@ pyro2
    compressible_react
    compressible_rk
    compressible_sdc
+   convergence
    diffusion
    examples
    incompressible

docs/source/modules.rst

@@ -10,9 +10,11 @@ Submodules
 ----------
 
 particles\.particles module
---------------------
+---------------------------
 
 .. automodule:: particles.particles
     :members:
     :undoc-members:
     :show-inheritance:
+
+

docs/source/particles.rst

@@ -1,5 +1,5 @@
 swe\.problems package
-==============================
+=====================
 
 .. automodule:: swe.problems
     :members:
@@ -10,49 +10,59 @@ Submodules
 ----------
 
 swe\.problems\.acoustic\_pulse module
-----------------------------------------------
+-------------------------------------
 
 .. automodule:: swe.problems.acoustic_pulse
     :members:
     :undoc-members:
     :show-inheritance:
 
 swe\.problems\.advect module
--------------------------------------
+----------------------------
 
 .. automodule:: swe.problems.advect
     :members:
     :undoc-members:
     :show-inheritance:
 
 swe\.problems\.dam module
-----------------------------------
+-------------------------
 
 .. automodule:: swe.problems.dam
     :members:
     :undoc-members:
     :show-inheritance:
 
 swe\.problems\.kh module
----------------------------------
+------------------------
 
 .. automodule:: swe.problems.kh
     :members:
     :undoc-members:
     :show-inheritance:
 
+swe\.problems\.logo module
+--------------------------
+
+.. automodule:: swe.problems.logo
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
 swe\.problems\.quad module
------------------------------------
+--------------------------
 
 .. automodule:: swe.problems.quad
     :members:
     :undoc-members:
     :show-inheritance:
 
 swe\.problems\.test module
------------------------------------
+--------------------------
 
 .. automodule:: swe.problems.test
     :members:
     :undoc-members:
     :show-inheritance:
+
+

docs/source/swe.problems.rst

@@ -1,5 +1,5 @@
 swe package
-====================
+===========
 
 .. automodule:: swe
     :members:
@@ -17,25 +17,27 @@ Submodules
 ----------
 
 swe\.derives module
-----------------------------
+-------------------
 
 .. automodule:: swe.derives
     :members:
     :undoc-members:
     :show-inheritance:
 
 swe\.simulation module
--------------------------------
+----------------------
 
 .. automodule:: swe.simulation
     :members:
     :undoc-members:
     :show-inheritance:
 
 swe\.unsplit\_fluxes module
-------------------------------------
+---------------------------
 
 .. automodule:: swe.unsplit_fluxes
     :members:
     :undoc-members:
     :show-inheritance:
+
+

docs/source/swe.rst

@@ -1,5 +1,8 @@
 pyro version history, with major changes noted
 
+2.2 : added shallow water solver
+      added particles support
+
 2.1 : documentation switched to Sphinx
       extensive flake8 clean-ups
       travis-ci for unit test (with 79% coverage)