__RegMeth __

Author : Joyce Ghantous
Date : 2025
Version : 1.0

RegMeth is a Python package designed for finite element mesh handling aimed for handeling registration problems. It provides tools for mesh generation, manipulation, validation, and visualization.

🏗️ Structure

This code is organized as follows:

regmeth/
│
├── FE_routines/ # Core finite element routines
│ ├── loc_assembler2/
│ │ ├── private/ # Essential functions
│ │ └── util/ # Utility tools
│ ├── Mesh2/
│ │ ├── P1/ # P1 mesh routines
│ │ ├── plots/ # Plotting tools
│ │ ├── utils/ # Mesh generation helpers
│ │ ├── geo/ # Geometries
│ │ ├── private/ # Core functions
│ │ └── validation/ # Validation scripts
│ └── Ref/ # Reference element, quadrature, interpolation
│
├── routines/
│ └── distmesh/ # 2D mesh generator using distance functions
│
├── Demo/ # Demonstrations of mesh generation
├── Plots/ # Generated plots for validation and demos
└── README.md # Project notice (this file)

🎯 Objective

RegMeth aims to provide robust tools for finite element mesh generation, handling, and interpolation on reference elements in 1D, 2D, and 3D. It is especially designed for high-order finite element computations and geometric validation.

🛠️ RegMeth Installation Guide

This project uses a pyproject.toml configuration with the hatchling build backend.
It requires Python ≥ 3.12.

1. Clone the Repository using with SSH or HTTPS key 🔑

     git clone ...
     cd redslab-2025/

2. Set Up a Virtual Environment

Create a virtual environment

     python3 -m venv .venv

Activate it :

• On macOS/Linux:

       source .venv/bin/activate 

• On Windows:

       .venv\Scripts\activate

3. 📥 Install the Project and Dependencies:

     pip install . 

4. ✅ Verify Installation

Run a demo script:

     python Demo/distmesh/circle.py