Commit 70efbb1e authored by René Fritze's avatar René Fritze
Browse files

[docs] fix some overlon markdown lines

parent 8480cd8e
......@@ -115,7 +115,8 @@ which will require that the [git](https://git-scm.com/) version control system i
installed on your system.
From time to time, the main branch of pyMOR undergoes major changes and things
might break (this is usually announced in our [discussion forum](https://github.com/pymor/pymor/discussions)),
might break (this is usually announced in our
[discussion forum](https://github.com/pymor/pymor/discussions)),
so you might prefer to install pyMOR from the current release branch:
pip install git+https://github.com/pymor/pymor@2022.2.x#egg=pymor[full]
......@@ -202,7 +203,8 @@ separately. Bindings for the following solver libraries are included:
* [Slycot](https://github.com/python-control/Slycot)
Python wrapper for the Subroutine Library in Systems and Control Theory (SLICOT) is also used for Hardy norm computations (`pymor.bindings.slycot`).
Python wrapper for the Subroutine Library in Systems and Control Theory (SLICOT) is also
used for Hardy norm computations (`pymor.bindings.slycot`).
Environments for pyMOR Development and Tests
-----------------------------------------------
......
......@@ -130,7 +130,8 @@ by executing:
from pymor.basic import *
from pymor.core.logger import set_log_levels
set_log_levels({'pymor.algorithms.greedy': 'ERROR', 'pymor.algorithms.gram_schmidt.gram_schmidt': 'ERROR', 'pymor.algorithms.image.estimate_image_hierarchical': 'ERROR'})
set_log_levels({'pymor.algorithms.greedy': 'ERROR', 'pymor.algorithms.gram_schmidt.gram_schmidt':
'ERROR', 'pymor.algorithms.image.estimate_image_hierarchical': 'ERROR'})
```
Next we will instantiate a class describing the analytical problem
......
......@@ -279,8 +279,8 @@ V = fom.solve(parameter_space.sample_randomly())
The matrix {math}`G` of all inner products between vectors in `trivial_basis`
is a so called [Gramian matrix](<https://en.wikipedia.org/wiki/Gramian_matrix>).
Consequently, every {{ VectorArray }} has a {meth}`~pymor.vectorarrays.interface.VectorArray.gramian` method, which computes precisely
this matrix:
Consequently, every {{ VectorArray }} has a {meth}`~pymor.vectorarrays.interface.VectorArray.gramian`
method, which computes precisely this matrix:
```{code-cell}
G = trivial_basis.gramian()
......
......@@ -145,8 +145,8 @@ with a few more advanced techniques added.
Again we define a `py:class\_` with appropiate name and docstring, but now we also indicate to pybind11
that this class will implement the [buffer protocol](<https://docs.python.org/3/c-api/buffer.html>), which basically
exposes direct access to the chunk of memory associated with a `Vector` instance to Python. We also see how we can dispatch multiple init functions
by using `py:init` objects with C++ lambda functions.
exposes direct access to the chunk of memory associated with a `Vector` instance to Python.
We also see how we can dispatch multiple init functions by using `py:init` objects with C++ lambda functions.
Note that direct memory access to the vector data from Python is not required to integrate a solver with pyMOR.
It is, however, useful for debugging and quickly modifying or extending the solver from within Python. For instance,
in our toy example we will use the direct memory access to quickly define a visualization of the solutions and to
......@@ -217,7 +217,8 @@ dir(model)
## Using the exported Python classes with pyMOR
All of pyMOR's algorithms operate on {{ VectorArray }} and {{ Operator }} objects that all share the same programming interface. To be able to use
All of pyMOR's algorithms operate on {{ VectorArray }} and {{ Operator }} objects that all
share the same programming interface. To be able to use
our Python `model.Vector` and `model.DiffusionOperator` in pyMOR, we have to provide implementations of
{{ VectorArray }}, {{ VectorSpace }} and {{ Operator }} that wrap the classes defined in the extension module
and translate calls to the interface methods into operations on `model.Vector` and `model.DiffusionOperator`.
......
pyMOR Logo Usage Guidelines
===========================
If you wish to reference pyMOR on your webpage, publication or presentation slides, you are welcome to use our logo. Here you can find different versions of the logo that you may use. Please use the logo as is and make no modifications. In particular:
If you wish to reference pyMOR on your webpage, publication or presentation slides,
you are welcome to use our logo. Here you can find different versions of the logo
that you may use. Please use the logo as is and make no modifications. In particular:
- Do not change the colors of the logo.
- Do not add a background color.
......@@ -10,6 +12,7 @@ If you wish to reference pyMOR on your webpage, publication or presentation slid
If you want to create a derived version of the logo for your own project, please ask us first.
<!-- markdownlint-disable MD033 -->
type | PNG | SVG
------|------|---------
color | <img src="pymor_logo.png" width=320> | <img src="pymor_logo.svg" width=320>
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment