Metadata-Version: 2.4
Name: gcor
Version: 0.1.0
Summary: Generalized correlation measures
Author-email: Ryota Suzuki <suzuki@ef-prime.com>
License-File: LICENSE
Requires-Python: >=3.9
Requires-Dist: numpy>=1.21
Requires-Dist: pandas>=1.5
Provides-Extra: dev
Requires-Dist: build>=1.0; extra == 'dev'
Requires-Dist: ipykernel; extra == 'dev'
Requires-Dist: jupyter; extra == 'dev'
Requires-Dist: pdoc; extra == 'dev'
Requires-Dist: pytest>=7; extra == 'dev'
Requires-Dist: pyyaml; extra == 'dev'
Requires-Dist: twine; extra == 'dev'
Description-Content-Type: text/markdown

# `gcor` library for Python
A Python implementation of generalized correlation measure.

**Note that this project is in an early stage of development, so changes
may occur frequently.**

## Documentation

Documentation site (user guide and API reference)
: <https://r-suzuki.github.io/gcor-py/>

User guide
: `README_USER.md`

## Development

This project uses `uv` and `Makefile` targets.

```bash
make sync     # install dependencies (incl. dev)
make test     # run tests
make testv    # run tests (verbose)
make docs     # build docs (pdoc + README_USER)
make build    # build sdist/wheel
make check    # full check before release
```

## References

`gcor` package for R
: <https://github.com/r-suzuki/gcor-r>
