Metadata-Version: 2.4
Name: lostinmsh
Version: 1.0.1
Summary: GMSH toolbox for locally structured meshes on polygon.
Project-URL: Homepage, https://github.com/zmoitier/lostinmsh
Project-URL: Documentation, https://zmoitier.github.io/lostinmsh
Project-URL: Issues, https://github.com/zmoitier/lostinmsh/issues
Author-email: Zoïs Moitier <zois.moitier@ensta.fr>, Camille Carvalho <camille.carvalho@insa-lyon.fr>
License: MIT License
        
        Copyright (c) 2026 Zoïs Moitier
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.11
Requires-Dist: gmsh
Requires-Dist: numpy
Requires-Dist: scipy
Provides-Extra: dev
Requires-Dist: docformatter[tomli]; extra == 'dev'
Requires-Dist: ipykernel; extra == 'dev'
Requires-Dist: ipython; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: scipy-stubs; extra == 'dev'
Provides-Extra: doc
Requires-Dist: nbsphinx; extra == 'doc'
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: sphinx-autodoc-typehints; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinx-rtd-theme; extra == 'doc'
Provides-Extra: plot
Requires-Dist: matplotlib; extra == 'plot'
Requires-Dist: meshio; extra == 'plot'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Description-Content-Type: text/markdown

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![Doc formatter: docformatter](https://img.shields.io/badge/%20formatter-docformatter-fedcba.svg)](https://github.com/PyCQA/docformatter)
[![Doc style: numpy](https://img.shields.io/badge/%20style-numpy-459db9.svg)](https://numpydoc.readthedocs.io/en/latest/format.html)

[![PyPI version](https://badge.fury.io/py/lostinmsh.svg)](https://badge.fury.io/py/lostinmsh)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.7677383.svg)](https://doi.org/10.5281/zenodo.7677383)
[![Documentation](https://github.com/zmoitier/lostinmsh/actions/workflows/docs.yml/badge.svg)](https://zmoitier.github.io/lostinmsh)

# lostinmsh

The Python toolbox `lostinmsh` (_LOcally STructured polygonal INterface MeSH_), is a package using `GMSH` to construct locally structured triangular meshes of polygons which are useful for sign changing PDE problem.

## Installation

Using [`pip`](https://pip.pypa.io/en/stable/)

```bash
$ python -m pip install lostinmsh
$ python -m pip install lostinmsh[plot]  # with plotting dependencies
```

Using [`uv`](https://docs.astral.sh/uv/)

```bash
$ uv add lostinmsh
$ uv add lostinmsh --optional plot  # with plotting dependencies
```

## [Documentation](https://zmoitier.github.io/lostinmsh)

## Requirements

- Python ≥ 3.14
- [`GMSH`](https://gmsh.info) ≥ 4
- [`numpy`](https://github.com/numpy/numpy)
- [`scipy`](https://github.com/scipy/scipy)

## Optional requirements (only use for plotting)

- [`matplotlib`](https://github.com/matplotlib/matplotlib)
- [`meshio`](https://github.com/nschloe/meshio)

## Acknowledgements

This research was partially supported by the National Science Foundation Grant: DMS-2009366.
