# Integraal

![Current Version](https://img.shields.io/crates/v/integraal?label=latest%20release)
![GitHub commits since latest release](https://img.shields.io/github/commits-since/imrn99/integraal/latest)
![Build Status](https://github.com/imrn99/integraal/actions/workflows/build.yml/badge.svg)
![Rust Tests](https://github.com/imrn99/integraal/actions/workflows/tests.yml/badge.svg)
[![codecov](https://codecov.io/gh/imrn99/integraal/graph/badge.svg?token=YNIE4B0ZXS)](https://codecov.io/gh/imrn99/integraal)

*Integraal* aims to provide generic and efficient tools for [numerical integration][NI] in the Rust Programming
Language.

[NI]: https://en.wikipedia.org/wiki/Numerical_integration

## Quickstart

You can add `integraal` as a dependency of your project by adding the following lines to its Cargo.toml:

```toml
# [dependencies]
integraal = { version = "0.1" }
```
or by running:

```sh
cargo add integraal
```

The Rust Doc is available for usage instructions, examples are provided with the source code / in the repository.

## Contributing

Contributions are welcome and accepted as pull requests on [GitHub][GH]. Feel free to file an issue to report bugs,
or suggest improvements and new features for the project.

[GH]: https://github.com/imrn99/integraal

## License

Licensed under either of

* Apache License, Version 2.0
  ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
* MIT license
  ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

at your preference.

The [SPDX](https://spdx.dev) license identifier for this project is `MIT OR Apache-2.0`.

Unless you explicitly state otherwise, any contribution intentionally submitted
for inclusion in the work by you, as defined in the Apache-2.0 license, shall be
dual licensed as above, without any additional terms or conditions.