gcor 0.1.0__tar.gz

gcor-0.1.0/.gitignore

@@ -0,0 +1,4 @@
+*.pyc
+*.pyo
+__pycache__/
+dist/

gcor-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ryota Suzuki
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

gcor-0.1.0/Makefile

@@ -0,0 +1,34 @@
+.PHONY: sync test testv build install-check docs check clean
+
+# Install dependencies (including development extras)
+sync:
+	uv sync --extra dev
+
+# Run tests quietly
+test:
+	uv run pytest -q
+
+# Run tests with stdout/stderr
+testv:
+	uv run pytest -s
+
+# Build source distribution and wheel (equivalent to R CMD build)
+build:
+	uv run python -m build
+
+# Build HTML docs with pdoc
+# - Adjust "gcor" to your top-level package/module name.
+# - "docs" is a convenient output dir for GitHub Pages.
+docs:
+	uv run quarto render README_USER.qmd
+	@VERSION=$$(uv run python -c "import tomllib; from pathlib import Path; d=tomllib.loads(Path('pyproject.toml').read_text(encoding='utf-8')); print(d['project']['version'])"); \
+	rm -rf docs; \
+	uv run pdoc --docformat numpy --math --footer-text "gcor v$${VERSION}" -o docs gcor
+
+# Full check before release (rough equivalent of R CMD CHECK)
+check: sync test build docs
+	@echo "✔ All checks completed successfully."
+
+# Remove build artifacts and temporary environments
+clean:
+	rm -rf dist build *.egg-info .venv-check docs

gcor-0.1.0/PKG-INFO

@@ -0,0 +1,50 @@
+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>

gcor-0.1.0/README.md

@@ -0,0 +1,31 @@
+# `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>

gcor-0.1.0/README_USER.md

@@ -0,0 +1,62 @@
+# A Python library for generalized correlation
+
+
+A Python implementation of generalized correlation measure. For
+development status and source code, see
+<https://github.com/r-suzuki/gcor-py>.
+
+**Note that this project is in an early stage of development, so changes
+may occur frequently.**
+
+## Installation
+
+``` bash
+pip install git+https://github.com/r-suzuki/gcor-py.git
+```
+
+## Examples
+
+**Generalized correlation measure** takes values in $[0, 1]$ and can
+capture both linear and nonlinear associations. It naturally handles
+mixed data types, including numerical and categorical variables.
+
+### Scalar example
+
+``` python
+from gcor import gcor
+
+x = [0, 0, 0, 0, 0, 1, 1, 1, 1, 1]
+y = [1, 2, 3, 4, 5, 3, 4, 5, 6, 7]
+
+g = gcor(x, y)
+print(g)
+```
+
+    0.5345224838248488
+
+### Matrix example (mixed numeric and categorical data)
+
+``` python
+import pandas as pd
+
+df = pd.DataFrame({
+    "x": x,
+    "y": y,
+    "z": ["a", "a", "b", "b", "c", "c", "d", "d", "e", "e"],
+})
+
+gmat = gcor(df)
+print(gmat)
+```
+
+              x         y         z
+    x  1.000000  0.534522  0.838289
+    y  0.534522  1.000000  0.763233
+    z  0.838289  0.763233  1.000000
+
+## Documentation
+
+### Method Overview
+
+- [English](https://r-suzuki.github.io/gcor/method.html)
+- [Japanese](https://r-suzuki.github.io/gcor/method_ja.html)

gcor-0.1.0/README_USER.qmd

@@ -0,0 +1,60 @@
+---
+title: A Python library for generalized correlation
+format: gfm
+jupyter: python3
+execute:
+  echo: true
+  warning: false
+  error: false
+---
+
+A Python implementation of generalized correlation measure. For development status and source code, see
+<https://github.com/r-suzuki/gcor-py>.
+
+**Note that this project is in an early stage of development, so changes
+may occur frequently.**
+
+## Installation
+
+```bash
+pip install git+https://github.com/r-suzuki/gcor-py.git
+```
+
+## Examples
+
+**Generalized correlation measure** takes values in $[0, 1]$ and can capture
+both linear and nonlinear associations. It naturally handles mixed data types,
+including numerical and categorical variables.
+
+### Scalar example
+
+```{python}
+from gcor import gcor
+
+x = [0, 0, 0, 0, 0, 1, 1, 1, 1, 1]
+y = [1, 2, 3, 4, 5, 3, 4, 5, 6, 7]
+
+g = gcor(x, y)
+print(g)
+```
+
+### Matrix example (mixed numeric and categorical data)
+
+```{python}
+import pandas as pd
+
+df = pd.DataFrame({
+    "x": x,
+    "y": y,
+    "z": ["a", "a", "b", "b", "c", "c", "d", "d", "e", "e"],
+})
+
+gmat = gcor(df)
+print(gmat)
+```
+
+## Documentation
+
+### Method Overview
+- [English](https://r-suzuki.github.io/gcor/method.html)
+- [Japanese](https://r-suzuki.github.io/gcor/method_ja.html)