Metadata-Version: 2.5
Name: adstk
Version: 0.0.1
Summary: ADSTK aims to bundle together relevant actuarial models, tools and code simplifications to enrich the Actuarial / Insurance Data Science experience in the Python ecosystem.
Project-URL: Homepage, https://codeberg.org/ftranschel/adstk
Project-URL: Repository, https://codeberg.org/ftranschel/adstk
Project-URL: Issues, https://codeberg.org/ftranschel/adstk/issues
Project-URL: Documentation, https://ftranschel.codeberg.page/adstk/
Author-email: Fabian Transchel <ftranschel@hs-harz.de>
License-Expression: MIT
License-File: LICENSE
Keywords: actuarial,aktuariat,data science,inspection,insurance,pricing,telematics
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: Financial
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: numpy>=1.24
Requires-Dist: pandas>=1.5
Requires-Dist: scipy>=1.10
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.25; extra == 'docs'
Provides-Extra: test
Requires-Dist: matplotlib; extra == 'test'
Requires-Dist: pytest; extra == 'test'
Requires-Dist: pytest-cov; extra == 'test'
Requires-Dist: scikit-learn; extra == 'test'
Description-Content-Type: text/markdown

# adstk

ADSTK aims to bundle together relevant actuarial models, tools and code simplifications to enrich the Actuarial / Insurance Data Science experience in the Python ecosystem.
---

## Features

ADSTK currently ships with a limited number of methods and use cases:

* Partial dependence display with support for individual conditional expectation curves (ICE)

### Dependencies

adstk requires:

- Python (>= 3.10)
- NumPy (>= 1.24)
- SciPy (>= 1.10)

Optional requirements for plotting etc.

- matplotlib ()
- plotly ()

### User installation

The easiest way to install adstk will using `pip` once we publish on PyPi:

    pip install -U adstk

## Changelog

See the [changelog](CHANGELOG.md) for a history of notable changes to adstk.

## Development

We welcome human contributors of all experience levels. The adstk community
goals are to be helpful, welcoming, and effective. The
[Contributing guide](CONTRIBUTING.md) has detailed information about
contributing code, documentation, tests, and more. Please also note our
[AI contribution policy](AGENTS.md) before submitting anything.

### Important links

- Official source code repo: https://codeberg.org/ftranschel/adstk
- Download releases: https://pypi.org/project/adstk/
- Issue tracker: https://codeberg.org/ftranschel/adstk/issues

### Source code

You can check the latest sources with the command:

    git clone https://codeberg.org/ftranschel/adstk.git

### Contributing

To learn more about making a contribution to adstk, please see our
[Contributing guide](CONTRIBUTING.md).

### Testing

After installation, you can launch the test suite from the source
directory (you will need `pytest` installed):

    pytest

### Submitting a Pull Request

Before opening a pull request, please read the
[Contributing guide](CONTRIBUTING.md) and our [AI policy](AGENTS.md) to
make sure your submission complies with our guidelines.
