Metadata-Version: 2.4
Name: ashx
Version: 0.0.2
Summary: FEniCSx tools
Author-email: Benjamin Vial <contact@bvial.info>
Maintainer-email: Benjamin Vial <contact@bvial.info>
License-Expression: GPL-3.0-or-later
Project-URL: Homepage, https://benvial.gitlab.io/ashx
Project-URL: Bug Reports, https://gitlab.com/benvial/ashx/issues
Project-URL: Source, https://gitlab.com/benvial/ashx
Keywords: fem,fenicsx
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Utilities
Requires-Python: <3.14,>=3.10
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: numpy
Requires-Dist: matplotlib
Requires-Dist: meshio
Requires-Dist: mpi4py
Requires-Dist: gmsh
Requires-Dist: pyvista
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Requires-Dist: pytest-cov; extra == "test"
Requires-Dist: pytest-datadir; extra == "test"
Requires-Dist: pytest-sugar; extra == "test"
Requires-Dist: pytest-xdist[psutil]; extra == "test"
Requires-Dist: coverage; extra == "test"
Requires-Dist: geolia>=0.0.2; extra == "test"
Provides-Extra: dev
Requires-Dist: wheel; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: isort; extra == "dev"
Requires-Dist: radon; extra == "dev"
Requires-Dist: pydocstyle; extra == "dev"
Requires-Dist: pylint; extra == "dev"
Requires-Dist: pylint-json2html; extra == "dev"
Requires-Dist: python-gitlab; extra == "dev"
Requires-Dist: pip-tools; extra == "dev"
Provides-Extra: doc
Requires-Dist: sphinx; extra == "doc"
Requires-Dist: furo; extra == "doc"
Requires-Dist: sphinx_gallery; extra == "doc"
Requires-Dist: sphinx-copybutton; extra == "doc"
Requires-Dist: memory_profiler; extra == "doc"
Requires-Dist: numpydoc; extra == "doc"
Requires-Dist: sphinxcontrib-svg2pdfconverter; extra == "doc"
Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
Requires-Dist: matplotlib; extra == "doc"
Requires-Dist: beautifulsoup4; extra == "doc"
Requires-Dist: sphinx-autoapi; extra == "doc"
Requires-Dist: myst-parser; extra == "doc"
Requires-Dist: sphinx-design; extra == "doc"
Requires-Dist: sphinx-inline-tabs; extra == "doc"
Requires-Dist: sphinx-tabs; extra == "doc"
Requires-Dist: sphinx-autobuild; extra == "doc"
Provides-Extra: full
Requires-Dist: ashx[test]; extra == "full"
Requires-Dist: ashx[doc]; extra == "full"
Requires-Dist: ashx[dev]; extra == "full"
Dynamic: license-file


<!-- start badges -->

<a class="reference external image-reference" href="https://gitlab.com/benvial/ashx/-/releases" target="_blank"><img alt="Release" src="https://img.shields.io/endpoint?url=https://gitlab.com/benvial/ashx/-/jobs/artifacts/main/raw/logobadge.json?job=badge&labelColor=c9c9c9"></a> 
<a class="reference external image-reference" href="https://gitlab.com/benvial/ashx/commits/main" target="_blank"><img alt="Release" src="https://img.shields.io/gitlab/pipeline/benvial/ashx/main?logo=gitlab&labelColor=dedede&style=for-the-badge"></a> 
<a class="reference external image-reference" href="https://benvial.gitlab.io/ashx" target="_blank"><img alt="License" src="https://img.shields.io/badge/documentation-website-dedede.svg?logo=readthedocs&logoColor=e9d672&style=for-the-badge"></a>
<a class="reference external image-reference" href="https://gitlab.com/benvial/ashx/commits/main" target="_blank"><img alt="Release" src="https://img.shields.io/gitlab/coverage/benvial/ashx/main?logo=python&logoColor=e9d672&style=for-the-badge"></a>
<a class="reference external image-reference" href="https://black.readthedocs.io/en/stable/" target="_blank"><img alt="Release" src="https://img.shields.io/badge/code%20style-black-dedede.svg?logo=python&logoColor=e9d672&style=for-the-badge"></a>
<a class="reference external image-reference" href="https://gitlab.com/benvial/ashx/-/blob/main/LICENSE.txt" target="_blank"><img alt="License" src="https://img.shields.io/badge/license-GPLv3-blue?color=aec2ff&logo=open-access&logoColor=aec2ff&style=for-the-badge"></a>

<!-- end badges -->

# ASHX


<!-- start elevator-pitch -->

**FEniCSx tools**

ASHX is a collection of tools and helpers for using [FEniCSx](https://fenicsproject.org) for finite element simulations. The package is built on top of Python and is designed for users who want to use FEniCSx without having to worry about the underlying C++ implementation.

The package provides a simple, Pythonic interface for creating and manipulating meshes, defining and solving partial differential equations, and visualizing the results of simulations. It also includes a number of helpful utilities for working with FEniCSx, such as functions for converting meshes between different formats and classes for defining and manipulating geometry.

The main features of ASHX include:


- **Convert gmsh meshes to dolfinx**
- **Base class for geometry definition**
- **Helpers for integration and measure**


<!-- end elevator-pitch -->


# Documentation

See the website with API reference and some examples at [benvial.gitlab.io/ashx](https://benvial.gitlab.io/ashx).



<!-- start installation -->

# Installation


## From Pypi

Simply run

```bash 
pip install ashx
```

<!-- ## From conda/mamba


```bash 
mamba install -c conda-forge ashx
``` -->

## From source

Clone the repository

```bash 
git clone https://gitlab.com/benvial/ashx.git
```

Install the package locally

```bash 
cd ashx
pip install -e .
```


## From gitlab

```bash 
pip install -e git+https://gitlab.com/benvial/ashx.git#egg=ashx
```


<!-- end installation -->
