Metadata-Version: 2.4
Name: ndelement
Version: 0.4.0
Classifier: Programming Language :: Rust
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Dist: maturin>=1.7.2
Requires-Dist: numpy
Requires-Dist: cffi
Requires-Dist: pytest
Requires-Dist: pip
Requires-Dist: patchelf ; platform_system == 'Linux'
License-File: LICENSE
Summary: Finite element definition library.
Home-Page: https://codeberg.org/nd-project/nd
Author-email: Matthew Scroggs <rust@mscroggs.co.uk>
Requires-Python: >=3.9
Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
Project-URL: documentation, https://bempp.github.io/nd/python/ndelement
Project-URL: homepage, https://codeberg.org/nd-project/nd
Project-URL: repository, https://codeberg.org/nd-project/nd

# ndelement

[![DefElement verification](https://defelement.org/badges/ndelement.svg)](https://defelement.org/verification/ndelement.html)
[![crates.io](https://img.shields.io/crates/v/ndelement?color=blue)](https://crates.io/crates/ndelement)
[![docs.rs](https://img.shields.io/docsrs/ndelement?label=docs.rs)](https://docs.rs/ndelement/latest/ndelement/)
[![PyPI](https://img.shields.io/pypi/v/ndelement?color=blue&label=PyPI&logo=pypi&logoColor=white)](https://pypi.org/project/ndelement/)

ndelement is an open-source Rust library for defining and tabulating finite elements on 1D, 2D, or
3D reference cells.

## Using ndelement
### Rust
You can use the latest release of ndelement by adding the following to `[dependencies]` section of your Cargo.toml file:

```toml
ndelement = "0.4.0"
```

### Python
You can install the latest release of ndelement by running:

```bash
pip3 install ndelement
```

The Python functionality of the library can be tested by running:
```bash
python -m pytest ndelement/python/test
```

## Documentation
The latest documentation of nelement is available at
[bempp.github.io/nd/rust/ndelement](https://bempp.github.io/nd/rust/ndelement/) (Rust)
and [bempp.github.io/nd/python/ndelement](https://bempp.github.io/nd/python/ndelement/) (Python).

## Testing
The Rust functionality of the library can be tested by running:
```bash
cargo test
```

## Examples
Examples of use can be found in the [examples](examples/) folder.

## Getting help
Errors in should be added to the [nd Codeberg issue tracker](https://codeberg.org/nd-project/nd/issues).

Questions about use can be asked on the [Bempp Discourse](https://bempp.discourse.group).

## Licence
ndelement is licensed under a BSD 3-Clause licence.

