Merge pull request #52 from ranocha/version_03

bump version to v0.3

doc/citing.rst

@@ -7,14 +7,14 @@ Citing RK-Opt
 Are you using RK-Opt in research work to be published?  If so, please include
 explicit mention of our work in your publication.  We suggest language such as this:
 
-    "To solve problem (17), we used RK-Opt, a package for optimization of Runge-Kutta
-    methods [1],[2]"
+    "To solve problem (17), we used RK-Opt, a package for the design of
+    numerical ODE solvers [1],[2]"
 
 with the following entry in your bibliography:
 
-    [1] **RK-Opt: Software for the design of Runge-Kutta methods**, version 0.2.
-    DI Ketcheson, M Parsani, and AJ Ahmadia.
-    http://numerics.kaust.edu.sa/RK-Opt, April 2013.
+    [1] **RK-Opt: A package for the design of numerical ODE solvers**, version 0.3.
+    David I. Ketcheson, Matteo Parsani, Aron J. Ahmadia, and Hendrik Ranocha.
+    http://numerics.kaust.edu.sa/RK-Opt, July 2020.
 
 as well as one or more of those below.  Specifically,
 if you use the **RK-coeff-opt** package to optimize SSP coefficients, please reference [2].
@@ -33,19 +33,18 @@ If you use the **am_rad-opt** package, please reference [6].
     David I. Ketcheson, *Journal of Computational Physics*, 229(5):1763-1773 (2010)
 
     [4] **Optimized explicit Runge-Kutta schemes for the spectral difference method applied to wave propagation problems**.
-    Matteo Parsani, David I. Ketcheson, and W Deconinck, *SIAM Journal on
-    Scientific Computing*. In press. Pre-print available at
-    http://arxiv.org/abs/1207.5830. (2013)
+    Matteo Parsani, David I. Ketcheson, and W. Deconinck, *SIAM Journal on
+    Scientific Computing*, 35(2):A957-A986 (2013)
 
-    [5] **Optimal stability polynomials for numerical integration of initial value problems**. 
+    [5] **Optimal stability polynomials for numerical integration of initial value problems**.
     David I. Ketcheson and Aron J. Ahmadia, *Communications in
     Applied Mathematics and Computational Science*, 7(2):247-271 (2012)
 
     [6] **Computation of optimal monotonicity preserving general linear methods**.
     David I. Ketcheson, *Mathematics of Computation*, 78(267):1497-1513 (2009)
 
     [7] **Strong Stability Preserving Two-step Runge–Kutta Methods.**
-    DI Ketcheson, S Gottlieb, CB Macdonald, *SIAM Journal on Numerical Analysis*,
+    David I. Ketcheson, Sigal Gottlieb, CB Macdonald, *SIAM Journal on Numerical Analysis*,
     2011;49(6):2618 (2011).
 
 Also, please do let us know if you are using this software so we can add your

doc/conf.py

@@ -13,7 +13,7 @@
 
 
 ######################################################################################
-# The following is needed only now. Once Sphinx 1.1 will be released it can be removed 
+# The following is needed only now. Once Sphinx 1.1 will be released it can be removed
 # because MathJax extension will be builtin in Sphinx 1.1
 # More info at https://bitbucket.org/birkenfeld/sphinx/issues?status=new&status=open
 sys.path.append(os.path.abspath('.'))
@@ -44,16 +44,16 @@
 
 # General information about the project.
 project = u'RK-Opt'
-copyright = u'2010-2012'
+copyright = u'2010-2020'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '0.2'
+version = '0.3'
 # The full version, including alpha/beta/rc tags.
-release = '0.2'
+release = '0.3'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -186,7 +186,7 @@
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'RK-Opt.tex', u'RK-Opt User Manual', u'David I. Ketcheson, Matteo Parsani, and Aron Ahmadia', 'manual'),
+  ('index', 'RK-Opt.tex', u'RK-Opt User Manual', u'David I. Ketcheson, Matteo Parsani, Aron J. Ahmadia, and Hendrik Ranocha', 'manual'),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of

doc/index.rst

@@ -39,7 +39,7 @@ The RK-Opt package consists of the following packages:
                         Some general utilities for analyzing Runge-Kutta methods.
 
 RK-Opt has been developed by David Ketcheson (primary developer and maintainer),
-Matteo Parsani, Hendrik Ranocha, and Aron Ahmadia.  Additional contributions include:
+Matteo Parsani, Aron Ahmadia, and Hendrik Ranocha.  Additional contributions include:
 
     + Order conditions for multistep RK methods of orders 9-11 (Christopher Bresten, Zachary Grant, and Daniel Higgs)
 

doc/rk-methods.rst

@@ -3,7 +3,7 @@
 ========================================
 Automated design of Runge-Kutta methods
 ========================================
-An `s`-stage Runge-Kutta method has roughly `s^2` coefficients (roughly `s^2/2` for explicit methods), 
+An `s`-stage Runge-Kutta method has roughly `s^2` coefficients (roughly `s^2/2` for explicit methods),
 which can be chosen
 so as to provide high accuracy, stability, or other properties.  Historically, most
 interest in Runge-Kutta methods has focused on methods using the minimum number of stages
@@ -24,4 +24,4 @@ algorithms will be the exception.
 RK-Opt contains a set of tools for designing Runge-Kutta methods in this paradigm.  It has been
 constructed mostly in the direct line of our research, but we have made some effort to help others
 easily understand and use it.  We hope that you find it useful, and that you will contribute any
-enhancements you may develop back to the project by sending us a pull request on Github.
+enhancements you may develop back to the project by sending us a pull request on `GitHub <https://github.com/ketch/RK-Opt>`_.

doc/started.rst

@@ -27,7 +27,7 @@ After unzipping/cloning, add the subdirectory ``RK-Opt/RKtools`` to your MATLAB
 =========================
 Testing your installation
 =========================
-You can test your RK-Opt installation by running the MATLAB script `test.m`.
+You can test your RK-Opt installation by running the MATLAB script ``test.m``.
 
 Running the tests
 -----------------

paper.md

@@ -41,7 +41,7 @@ methods for specific applications is an important area of research.
 `RK-Opt` is a software package for designing numerical ODE solvers with
 coefficients optimally chosen to provide desired properties.
 It is available from https://github.com/ketch/RK-Opt, with documentation
-at http://numerics.kaust.edu.sa/RK-opt/.
+at http://numerics.kaust.edu.sa/RK-Opt/.
 The primary focus of the package is on the design of Runge-Kutta methods, but
 some routines for designing other classes of methods such as multistep
 Runge-Kutta and general linear methods are also included.