rmesh is a module which can perform mesh generation for 2D, rectangular, elliptical, semi-structured meshes. It does that by iteratively solving the Laplace equation for the position of the mesh nodes.
The module depends on numpy for its arrays, which are used to access most of the mesh data.
For building the actual package there are additional dependencies on CMake and scikit-build-core, which are needed to build the C extension which is used by the module to quickly generate and solve the system of equations.
To build rmesh, numpy, CMake, scikit-build-core are needed. To build and install the Python package follow the following steps:
- Clone the repository via
git clone <repo> <dir> && cd <dir> - Pull dependencies from git
git submodule init. This will pull the library used for linear algebra and iterative solver. - Build the package wheel(s) using Python
python -m build <output-dir> - Install the package from the wheel with
pip install <output-dir>/rmesh-*.whl
Built documentation is hosted using Github pages here. If you wish to build them yourself, you can do
so by installing the package with optional dependency [doc] (for example, if you are in the source directory, call pip install .[doc]).
Following that, you can build the documentation pages by calling sphinx-build doc <out-dir>.