High-level interface for solving linear systems with hypre, providing a user-friendly way to leverage its functionalities. Key features are:
- YAML Input: Accepts configuration parameters written in the structured and human-readable YAML format.
- Intuitive Interface: Offers a clear and concise API, encapsulating the functionalities of hypre to ensure user-friendly interactions.
- Prototyping: Establishes a quick prototyping framework, facilitating the exploration of various solver/preconditioner setups.
- Testing: Enables the construction of an integrated testing framework, accommodating problems from applications built on hypre.
The instructions for building hypredrive are given below:
$ autoreconf -i
$ ./configure --prefix=${PWD}/install --with-hypre-dir=${HYPRE_INSTALL_DIR}
$ make all
$ make check
$ make install
Note:
- The first step must be executed only once after cloning this repository.
- hypre needs to be installed at
${HYPRE_INSTALL_DIR}. - For GPU support, add
--with-cuda(NVIDIA GPUs) or--with-hip(AMD GPUs) to./configure.
The user's manual has a detailed section about running examples. For a quick-start, try running the first example from the top-level folder:
$ mpirun -np 1 ./hypredrive examples/ex1.yml
Check hypredrive's manual here.
Please read CONTRIBUTING for details on contributing to hypredrive, including the process for submitting pull requests to us.
If you are referencing hypredrive in a publication, please cite the following paper:
Magri, V. A. P. (2024). Hypredrive: High-level interface for solving linear systems
with hypre. Journal of Open Source Software,
9(98), 6654. https://doi.org/10.21105/joss.06654
You can easily obtain the citation in APA or BibTeX format directly from GitHub. Navigate to the "Cite this repository" option located in the "About" section. Alternatively, you can find the raw BibTeX format in the comments section of the CITATION file.
This project is licensed under the MIT License - see the LICENSE file for details. All new contributions must be made under this license.
SPDX-License-Identifier: MIT
LLNL-CODE-861860