Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/scivision/mumps
MUMPS via CMake
https://github.com/scivision/mumps
Last synced: 14 days ago
JSON representation
MUMPS via CMake
- Host: GitHub
- URL: https://github.com/scivision/mumps
- Owner: scivision
- License: mit
- Created: 2021-04-20T18:15:45.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-02T01:18:49.000Z (7 months ago)
- Last Synced: 2024-05-02T03:09:23.187Z (7 months ago)
- Language: CMake
- Homepage: http://mumps-solver.org
- Size: 507 KB
- Stars: 92
- Watchers: 10
- Forks: 36
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# MUMPS sparse solver
[](https://github.com/scivision/mumps/actions/workflows/ci.yml)
[](https://github.com/scivision/mumps/actions/workflows/ci_build.yml)
[](https://github.com/scivision/mumps/actions/workflows/oneapi-linux.yml)
CMake downloads the unmodified source tarfile from MUMPS developers and builds.
CMake builds MUMPS in parallel faster and more conveniently than the original Makefiles.
CMake allows easy reuse of MUMPS in external projects via CMake
[FetchContent](https://github.com/scivision/mumps-fetchcontent)
or ExternalProject or `cmake --install`.
[MUMPS CeCILL-C license](https://mumps-solver.org/index.php?page=dwnld#license)
is distinct from this CMake script license.
MUMPS teams typically make new
[releases](https://mumps-solver.org/index.php?page=dwnld#cl)
each year.
Many compilers and systems are supported by CMake build system on Windows, MacOS and Linux.
Static (default) or Shared `cmake -DBUILD_SHARED_LIBS=on` MUMPS builds are supported.
Platforms known to work with MUMPS and CMake include:
* [Windows](./Readme_Windows.md)
* MacOS
* GCC (Homebrew)
* Linux
* GCC
* Intel [oneAPI](./Readme_oneapi.md)
* NVIDIA HPC SDK
* Cray
By default PORD ordering is used.
[Scotch, METIS, and parMETIS ordering](./Readme_ordering.md)
can be used.
Several [LAPACK vendors](./Readme_LAPACK.md) are supported.
The MUMPS project is distinct from this CMake script wrapper.
See the
[MUMPS Users email list](https://listes.ens-lyon.fr/sympa/subscribe/mumps-users)
and
[MUMPS User Guide](https://mumps-solver.org/index.php?page=doc)
for any questions about MUMPS itself.
## Build
From this repo's top directory:
```sh
cmake -B build
cmake --build build
```
Numerous MUMPS [build options are available](./Readme_options.md).
With the default options the build/ directory contains library binaries ([Windows](./Readme_Windows.md) binaries have different names):
* libdmumps.a (real64)
* libsmumps.a (real32)
* libmumps_common.a (common MUMPS routines)
* libpord.a (PORD library)
If `-DMUMPS_parallel=no` was set, an additional helper library is built in place of linking MPI libraries:
* libmpiseq.a
These libraries can be linked into C, C++, Fortran, etc. programs, or even be used with appropriate interfaces from [Matlab](./Readme_matlab.md) and Python
[PyMUMPS](https://pypi.org/project/PyMUMPS/)
and
[python-mumps](https://pypi.org/project/python-mumps/).
## Self test and examples
Optionally, run self-tests:
```sh
ctest --test-dir build
```
To build the example, first "install" the MUMPS package-the default install location is under the MUMPS build/local directory:
```sh
cmake --install build
cmake -S example -B example/build -DMUMPS_ROOT=build/local
cmake --build example/build
```
## Using binary libraries
Linking the MUMPS binaries into a user-program is project-dependent.
An example using the examples in this project with GNU GCC, using the "mpicxx" MPI compiler wrapper:
```sh
mpicxx ./example/d_example.cpp -I./build/local/include -L./build/local/lib -ldmumps -lmumps_common -lpord -lscalapack -lblacs -llapack -lblas -lgfortran
```
If `-DMUMPS_parallel=no` was used to build MUMPS, instead do:
```sh
g++ ./example/d_example.cpp -I./build/local/include -L./build/local/lib -ldmumps -lmumps_common -lpord -llapack -lblas -lmpiseq -lgfortran
```