Metadata-Version: 2.1
Name: includeigen
Version: 0.1
Summary: `includeigen` can be used by Python packages that require the C++ library `Eigen`. It includes a version of `Eigen`, and a `get_include` function that returns the path to the directory of the source code.
Home-page: https://github.com/changepoints/includeigen
Author: Charles Truong
Author-email: me@email.com
License: BSD-3-Clause
Project-URL: Documentation, https://includeigen.readthedocs.io/
Project-URL: Bug Tracker, https://github.com/changepoints/includeigen/issues
Project-URL: Discussions, https://github.com/changepoints/includeigen/discussions
Project-URL: Changelog, https://github.com/changepoints/includeigen/releases
Platform: Any
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
License-File: LICENSE

# includeigen

[![Actions Status][actions-badge]][actions-link][![PyPI version][pypi-version]][pypi-link][![Conda-Forge][conda-badge]][conda-link][![PyPI platforms][pypi-platforms]][pypi-link][![GitHub Discussion][github-discussions-badge]][github-discussions-link]

`includeigen` can be used by Python packages that require the C++ library
`Eigen`. It includes a version of `Eigen`, and a `get_include` function that
returns the path to the directory of the source code.

Currently, the version of Eigen is 3.4.0.

### Install

The `includeigen` is available on Pypi and conda-forge. Simply execute

```bash
python -m pip install includeigen
```

or

```bash
conda install includeigen -c conda-forge
```

### Developer's Corner

- To change Eigen's version, checkout the submodule to the corresponding tag
  (e.g. `3.4`) and commit the change.

- To release a new version, make a new github release. The chosen tag will be
  the version number.

<!-- prettier-ignore-start -->
[actions-badge]:            https://github.com/changepoints/includeigen/workflows/CI/badge.svg
[actions-link]:             https://github.com/changepoints/includeigen/actions
[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/includeigen
[conda-link]:               https://github.com/conda-forge/includeigen-feedstock
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]:  https://github.com/changepoints/includeigen/discussions
[pypi-link]:                https://pypi.org/project/includeigen/
[pypi-platforms]:           https://img.shields.io/pypi/pyversions/includeigen
[pypi-version]:             https://img.shields.io/pypi/v/includeigen

<!-- prettier-ignore-end -->
