pyMOR is a software library for building model order reduction applications with the Python programming language. Implemented algorithms include reduced basis methods for parametric linear and non-linear problems, as well as system-theoretic methods such as balanced truncation or IRKA (Iterative Rational Krylov Algorithm). All algorithms in pyMOR are formulated in terms of abstract interfaces for seamless integration with external PDE (Partial Differential Equation) solver packages. Moreover, pure Python implementations of FEM (Finite Element Method) and FVM (Finite Volume Method) discretizations using the NumPy/SciPy scientific computing stack are provided for getting started quickly.
Copyright 2013-2020 pyMOR developers and contributors. All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
The following files contain source code originating from other open source software projects:
- docs/source/pymordocstring.py (sphinxcontrib-napoleon)
- src/pymor/algorithms/genericsolvers.py (SciPy)
See these files for more information.
If you use pyMOR for academic work, please consider citing our publication:
R. Milk, S. Rave, F. Schindler
pyMOR - Generic Algorithms and Interfaces for Model Order Reduction
SIAM J. Sci. Comput., 38(5), pp. S194--S216, 2016
We recommend installation of pyMOR in a virtual environment.
pyMOR can easily be installed with the pip command:
pip install --upgrade pip # make sure that pip is reasonably new
pip install pymor[full]
(Please note that pip must be at least version 19.0)
This will install the latest release of pyMOR on your system with most optional dependencies. For Linux we provide binary wheels, so no further system packages should be required. Use
pip install pymor
for an installation with minimal dependencies.
There are some optional packages not included with pymor[full]
because they need additional setup on your system:
-
for support of MPI distributed models and parallelization of greedy algorithms (requires MPI development headers and a C compiler):
pip install mpi4py -
dense matrix equation solver for system-theoretic MOR methods, required for H-infinity norm calculation (requires OpenBLAS headers and a Fortran compiler):
pip install slycot -
dense and sparse matrix equation solver for system-theoretic MOR methods (other backends available):
If you are not operating in a virtual environment, you can pass the optional --user
argument to pip. pyMOR will then only be installed for your
local user, not requiring administrator privileges.
To install the latest development version of pyMOR, execute
pip install git+https://github.com/pymor/pymor#egg=pymor[full]
which will require that the git version control system is installed on your system.
From time to time, the master branch of pyMOR undergoes major changes and things might break (this is usually announced in our discussion forum), so you might prefer to install pyMOR from the current release branch:
pip install git+https://github.com/pymor/[email protected]#egg=pymor[full]
Release branches will always stay stable and will only receive bugfix commits after the corresponding release has been made.
pyMOR can be installed using conda by running
conda install -c conda-forge pymor
Documentation is available online or you can build it yourself from inside the root directory of the pyMOR source tree by executing:
make docs
This will generate HTML documentation in docs/_build/html.
pyMOR has been designed with easy integration of external PDE solvers in mind.
A basic approach is to use the solver only to generate high-dimensional
system matrices which are then read by pyMOR from disk (pymor.discretizers.disk).
Another possibility is to steer the solver via an appropriate network
protocol.
Whenever possible, we recommend to recompile the solver as a
Python extension module which gives pyMOR direct access to the solver without
any communication overhead. A basic example using
pybind11 can be found in
src/pymordemos/minimal_cpp_demo. Moreover,
we provide bindings for the following solver libraries:
-
MPI-compatible wrapper classes for dolfin linear algebra data structures are shipped with pyMOR (
pymor.bindings.fenics). For an example seepymordemos.thermalbock,pymordemos.thermalblock_simple. It is tested using version 2019.1.0. -
Python bindings and pyMOR wrapper classes can be found here.
-
Wrapper classes for the NGSolve finite element library are shipped with pyMOR (
pymor.bindings.ngsolve). For an example seepymordemos.thermalblock_simple. It is tested using version v6.2.2006.
Do not hesitate to contact us if you need help with the integration of your PDE solver.
pyMOR also provides bindings to matrix equation solvers (in pymor.bindings),
which are needed for the system-theoretic methods and need to be installed
separately. Bindings for the following solver libraries are included:
-
The Matrix Equation Sparse Solver library is intended for solving large sparse matrix equations (
pymor.bindings.pymess). -
Python wrapper for the Subroutine Library in Systems and Control Theory (SLICOT) is also used for Hardy norm computations (
pymor.bindings.slycot).
If you already installed a pyMOR release version, please uninstall it
pip uninstall pyMOR
Then, clone the pyMOR git repository using
git clone https://github.com/pymor/pymor $PYMOR_SOURCE_DIR
cd $PYMOR_SOURCE_DIR
and, optionally, switch to the branch you are interested in, e.g.
git checkout 2020.1.x
Then, make an editable installation of pyMOR with
pip install -e .[full]
pyMOR uses pytest for unit testing. To run the test suite,
simply execute make test in the base directory of the pyMOR repository. This will
run the pytest suite with the default hypothesis profile "dev". For available profiles
see src/pymortests/conftest.py. A profile is selected by running make PYMOR_HYPOTHESIS_PROFILE=PROFILE_NAME test.
If docker is available, use make PYMOR_HYPOTHESIS_PROFILE=PROFILE_NAME docker_test to execute the test suite
in the same environment as on pyMOR's CI infrastructure. Additional customization points are listed at the top of the
Makefile. If required set PYMOR_SUDO=1 in your environment to execute docker with elevated rights.
Run make full-test which will also enable
pyflakes and
pep8 checks.
All tests are contained within the src/pymortests directory and can be run
individually by executing py.test src/pymortests/the_module.py.
Should you have any questions regarding pyMOR or wish to contribute, do not hestitate to contact us via our GitHub discussions forum: