Skip to content

Commit 651b0ba

Browse files
authored
Bugfix broken links reported by check-docs (#56)
* Remove broken link to SRSchur MATLAB code. * Replace link to Jan Brandts publication by link to preprint. * Remove Brandts link in references.rst.
1 parent 09e817e commit 651b0ba

4 files changed

Lines changed: 7 additions & 10 deletions

File tree

README.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ for the longstanding and productive collaboration in the field of Markov modelin
139139
M. Weber, together with Susanna Röblitz and K. Fackeldey, had the original idea to employ Schur
140140
vectors instead of eigenvectors in the coarse-graining of non-reversible transition matrices. |br|
141141
Further, we would like to thank `Fabian Paul`_ for valuable discussions regarding the sorting of Schur vectors and his
142-
effort to translate the original sorting routine for real Schur forms, `SRSchur`_ published by `Jan Brandts`_,
142+
effort to translate the original sorting routine for real Schur forms, SRSchur published by `Jan Brandts`_,
143143
from MATLAB into `Python code`_,
144144
M. Weber and `Alexander Sikorski`_ for pointing us to `SLEPc`_ for sorted partial Schur decompositions,
145145
and A. Sikorski for supplying us with an `code example`_ and guidance how to interface SLEPc in Python.
@@ -152,8 +152,7 @@ Further, utility functions found in `pygpcca/utils/_utils.py`_ originate from MS
152152
.. _`CMD`: https://www.zib.de/numeric/cmd
153153
.. _`ZIB`: https://www.zib.de/
154154
.. _`Fabian Paul`: https://github.com/fabian-paul
155-
.. _`SRSchur`: http://m2matlabdb.ma.tum.de/SRSchur.m?MP_ID=119
156-
.. _`Jan Brandts`: https://doi.org/10.1002/nla.274
155+
.. _`Jan Brandts`: https://www.math.uu.nl/publications/preprints/1180.pdf
157156
.. _`Python code`: https://gist.github.com/fabian-paul/14679b43ed27aa25fdb8a2e8f021bad5
158157
.. _`Alexander Sikorski`: https://www.zib.de/members/sikorski
159158
.. _`SLEPc`: https://slepc.upv.es/

docs/source/acknowledgments.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ for the longstanding and productive collaboration in the field of Markov modelin
55
M. Weber, together with Susanna Röblitz and K. Fackeldey, had the original idea to employ Schur
66
vectors instead of eigenvectors in the coarse-graining of non-reversible transition matrices.
77
Further, we would like to thank `Fabian Paul`_ for valuable discussions regarding the sorting of Schur vectors and his
8-
effort to translate the original sorting routine for real Schur forms, `SRSchur`_ published by `Jan Brandts`_,
8+
effort to translate the original sorting routine for real Schur forms, SRSchur published by `Jan Brandts`_,
99
from MATLAB into `Python code`_,
1010
M. Weber and `Alexander Sikorski`_ for pointing us to `SLEPc`_ for sorted partial Schur decompositions,
1111
and A. Sikorski for supplying us with an `code example`_ and guidance how to interface SLEPc in Python.
@@ -18,8 +18,7 @@ Further, utility functions found in `pygpcca/utils/_utils.py`_ originate from MS
1818
.. _`CMD`: https://www.zib.de/numeric/cmd
1919
.. _`ZIB`: https://www.zib.de/
2020
.. _`Fabian Paul`: https://github.com/fabian-paul
21-
.. _`SRSchur`: http://m2matlabdb.ma.tum.de/SRSchur.m?MP_ID=119
22-
.. _`Jan Brandts`: https://doi.org/10.1002/nla.274
21+
.. _`Jan Brandts`: https://www.math.uu.nl/publications/preprints/1180.pdf
2322
.. _`Python code`: https://gist.github.com/fabian-paul/14679b43ed27aa25fdb8a2e8f021bad5
2423
.. _`Alexander Sikorski`: https://www.zib.de/members/sikorski
2524
.. _`SLEPc`: https://slepc.upv.es/

docs/source/installation.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Conda
1515
This is the recommended way of installing, since this package also includes `PETSc`_/`SLEPc`_ libraries.
1616
We use `PETSc`_/`SLEPc`_ internally to speed up the computation of the leading Schur vectors. These are optional
1717
dependencies - if they're not present, we compute a full Schur decomposition instead and sort it using the method
18-
introduced by `Brandts (2002)`_. Note that this scales cubically in sample number, making it essential to use
18+
introduced by `Brandts (2001)`_. Note that this scales cubically in sample number, making it essential to use
1919
`PETSc`_/`SLEPc`_ for large sample numbers. `PETSc`_/`SLEPc`_ implement iterative methods to only compute
2020
the leading Schur vectors, which is computationally much less expensive.
2121

@@ -86,7 +86,7 @@ The installation steps can be roughly outlined as::
8686
# install slepc4py
8787
pip install --user petsc4py
8888

89-
.. _`Brandts (2002)`: https://doi.org/10.1002/nla.274
89+
.. _`Brandts (2001)`: https://www.math.uu.nl/publications/preprints/1180.pdf
9090
.. _`PETSc`: https://www.mcs.anl.gov/petsc/
9191
.. _`SLEPc`: https://slepc.upv.es/
9292
.. _`PETSc installation guide`: https://www.mcs.anl.gov/petsc/documentation/installation.html

docs/source/references.rst

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,8 @@ References
1919
2020
.. [Brandts02]
2121
Jan H. Brandts, |br|
22-
*Matlab code for sorting real Schur forms*, |br|
22+
*Matlab ode for sorting real Schur forms*, |br|
2323
Numerical Linear Algebra with Applications, 9(3):249-261, 2002.
24-
`doi:10.1002/nla.274 <https://doi.org/10.1002/nla.274>`__.
2524
2625
.. [Roeblitz13]
2726
Susanna Röblitz and Marcus Weber, |br|

0 commit comments

Comments
 (0)