Reference to pylops in LinearOperator notes and ARPACK example

[mrava87]

• Add reference to pylops project in LinearOperator notes.
• Added example with LinearOperator to Sparse Eigenvalue Problems with ARPACK tutorial.

[mrava87]

I didn't realise that the code snippets in your tutorials are actually tested on travis. How should I go about here:

• add pylops to dependencies for develop (but not user) if this is possible?
• not use pylops in example in ARPACK tutorial but actually create some operators in the tutorial itself (that may make the code longer and quite verbose).
• avoid travis from running the snippet (if possible?)

[rgommers]

not use pylops in example in ARPACK tutorial but actually create some operators in the tutorial itself (that may make the code longer and quite verbose).

This would be preferred. I was thinking something like:

• example of basic LinearOperator use
• example of creating an operator (if not too verbose)
• then a short paragraph explaining that PyLops defines more operators and helps also if you want to create your own. and then a link to PyLops.

[rgommers]

add pylops to dependencies for develop (but not user) if this is possible?

this is in principle possible, but I don't think we want to do this. refguide_check should also pass locally, so we'd then be requiring devs to also install PyLops.

[mrava87]

Hi Ralf, I agree. I can modify the example as you suggest, should be easy to have one or two operators that are simple to create with few lines of code. Will update the pull request :) iMR

…

On 18 Dec 2018, at 08:00, Ralf Gommers ***@***.***> wrote: not use pylops in example in ARPACK tutorial but actually create some operators in the tutorial itself (that may make the code longer and quite verbose). This would be preferred. I was thinking something like: example of basic LinearOperator use example of creating an operator (if not too verbose) then a short paragraph explaining that PyLops defines more operators and helps also if you want to create your own. and then a link to PyLops. — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

[mrava87]

Not sure I understand why Travis is giving all these indentation errors (and just for one specific build)?

Is there a way to locally build the doc with checks on the '>>>' codes? If I run python setup.py build_sphinx everything works fine and the documentation looks like I expect it to look

[tylerjereddy]

We have a special script in tools/refguide_check.py that executes the docstrings and checks for the expected output, as you've noticed.

In our continuous integration there is a single matrix entry in travis that includes the command python runtests.py -g --refguide-check, and you should be able to use that locally as a first pass at refining your docstrings so they pass.

[mrava87]

Thanks a lot, that helps! Will do that :)

[mrava87]

Now the doctoring checks are successful and Travis builds :) not sure why the CircleCI pypy3 fails as it was working fine before and I did not change any real code. Seems like I can't rerun the workflow from https://circleci.com/gh/scipy/scipy/10468?utm_campaign=vcs-integration-link&utm_medium=referral&utm_source=github-build-link, maybe someone with privileges can do it?

[rgommers]

Don't worry about the PyPy failure, that was just a CI hiccup (Too long with no output (exceeded 10m0s)).

[rgommers]

overall looks good to me, only a few minor comments.

[rgommers]

Thanks @mrava87, merged.

[mrava87]

Thanks a lot to you for help :)