readme

Author: TY-Cheng

README.md

@@ -3,13 +3,13 @@
 [![Codacy Badge](https://app.codacy.com/project/badge/Grade/e8a7a7448b2043d9bbefafc5a3ec14f7)](https://app.codacy.com/gh/TY-Cheng/torchvinecopulib/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
 [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/e8a7a7448b2043d9bbefafc5a3ec14f7)](https://app.codacy.com?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 [![Lint Pytest](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml)
-[![Deploy Docs](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/static.yml/badge.svg?branch=main)](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/static.yml)
+[![Deploy Docs](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/static.yml/badge.svg?branch=main)](https://ty-cheng.github.io/torchvinecopulib/)
 
 ![PyPI - Python Version](https://img.shields.io/pypi/pyversions/torchvinecopulib)
 [![OS](https://img.shields.io/badge/OS-Windows%7CmacOS%7CUbuntu-blue)](https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml)
 
-![GitHub License](https://img.shields.io/github/license/ty-cheng/torchvinecopulib)
-![PyPI - Version](https://img.shields.io/pypi/v/torchvinecopulib)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/TY-Cheng/torchvinecopulib/blob/main/LICENSE)
+[![PyPI - Version](https://img.shields.io/pypi/v/torchvinecopulib)](https://pypi.org/project/torchvinecopulib/)
 [![DOI](https://zenodo.org/badge/768037665.svg)](https://zenodo.org/doi/10.5281/zenodo.10836953)
 
 Yet another vine copula package, using [PyTorch](https://pytorch.org/get-started/locally/).
@@ -21,32 +21,9 @@ Yet another vine copula package, using [PyTorch](https://pytorch.org/get-started
 - Pure `Python` library, inspired by [pyvinecopulib](https://github.com/vinecopulib/pyvinecopulib/) on Windows, Linux, MacOS
 - IO and visualization support
 
-## Dependencies
-
-```toml
-# inside the `./pyproject.toml` file;
-fastkde = "*"
-numpy = "*"
-pyvinecopulib = "*"
-python = ">=3.12"
-scipy = "*"
-# optional to facilitate customization
-torch = [
-    { index = "torch-cpu", extra = "cpu" },
-    { index = "torch-cu126", extra = "cu126" },
-]
-```
-
-For [PyTorch](https://pytorch.org/get-started/locally/) with `cuda`:
-
-```bash
-pip install torch --index-url https://download.pytorch.org/whl/cu126 --force-reinstall
-# check cuda availability
-python -c "import torch; print(torch.cuda.is_available())"
-```
+## Examples
 
-> [!TIP]
-> macOS users should set `device='cpu'` at this stage, for using `device='mps'` won't support `dtype=torch.float64`.
+Visit the [`./examples/`](https://github.com/TY-Cheng/torchvinecopulib/tree/main/examples) folder for `.ipynb` Jupyter notebooks.
 
 ## Installation
 
@@ -66,7 +43,7 @@ pip install ./dist/torchvinecopulib-1.0.4-py3-none-any.whl
 pip install ./dist/torchvinecopulib-1.0.4.tar.gz
 ```
 
-### (Optional) [uv](https://docs.astral.sh/uv/getting-started/) for Dependency Management and Packaging
+### (Recommended) [uv](https://docs.astral.sh/uv/getting-started/) for Dependency Management and Packaging
 
 After `git clone https://github.com/TY-Cheng/torchvinecopulib.git`, `cd` into the project root where [`pyproject.toml`](https://github.com/TY-Cheng/torchvinecopulib/blob/main/pyproject.toml) exists,
 
@@ -77,9 +54,32 @@ uv sync --extra cpu -U
 uv sync --extra cu126 -U
 ```
 
-## Examples
+## Dependencies
 
-Visit the [`./examples/`](https://github.com/TY-Cheng/torchvinecopulib/tree/main/examples) folder for `.ipynb` Jupyter notebooks.
+```toml
+# inside the `./pyproject.toml` file;
+fastkde = "*"
+numpy = "*"
+pyvinecopulib = "*"
+python = ">=3.12"
+scipy = "*"
+# optional to facilitate customization
+torch = [
+    { index = "torch-cpu", extra = "cpu" },
+    { index = "torch-cu126", extra = "cu126" },
+]
+```
+
+For [PyTorch](https://pytorch.org/get-started/locally/) with `cuda`:
+
+```bash
+pip install torch --index-url https://download.pytorch.org/whl/cu126 --force-reinstall
+# check cuda availability
+python -c "import torch; print(torch.cuda.is_available())"
+```
+
+> [!TIP]
+> macOS users should set `device='cpu'` at this stage, for using `device='mps'` won't support `dtype=torch.float64`.
 
 ## Documentation
 
@@ -90,6 +90,9 @@ Visit the [`./examples/`](https://github.com/TY-Cheng/torchvinecopulib/tree/main
 ```bash
 # inside project root folder
 sphinx-apidoc -o ./docs ./torchvinecopulib && cd ./docs && make html && cd ..
+# if using uv
+uv run sphinx-apidoc -o docs torchvinecopulib/ --separate
+uv run sphinx-build docs docs/_build/html
 ```
 
 ## Tests
@@ -99,6 +102,9 @@ sphinx-apidoc -o ./docs ./torchvinecopulib && cd ./docs && make html && cd ..
 python -m pytest ./tests
 # coverage report
 coverage run -m pytest ./tests && coverage html
+# if using uv
+uv run coverage run --source=torchvinecopulib -m pytest ./tests
+uv run coverage report -m
 ```
 
 ## TODO

docs/index.rst

@@ -10,17 +10,17 @@ Welcome to torchvinecopulib's documentation!
 .. raw:: html
 
    <p align="center">
-     <a href="https://app.codacy.com/gh/TY-Cheng/torchvinecopulib/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade"><img src="https://app.codacy.com/project/badge/Grade/e8a7a7448b2043d9bbefafc5a3ec14f7" alt="Codacy Grade"/></a>
-     <a href="https://app.codacy.com?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage"><img src="https://app.codacy.com/project/badge/Coverage/e8a7a7448b2043d9bbefafc5a3ec14f7" alt="Codacy Coverage"/></a>
-     <a href="https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml"><img src="https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml/badge.svg?branch=main" alt="Lint Pytest"/></a>
-     <a href="https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/static.yml"><img src="https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/static.yml/badge.svg?branch=main" alt="Deploy Docs"/></a>
+     <a href="https://app.codacy.com/gh/TY-Cheng/torchvinecopulib/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade" target="_blank" rel="noopener noreferrer"><img src="https://app.codacy.com/project/badge/Grade/e8a7a7448b2043d9bbefafc5a3ec14f7" alt="Codacy Grade"/></a>
+     <a href="https://app.codacy.com/gh/TY-Cheng/torchvinecopulib/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage" target="_blank" rel="noopener noreferrer"><img src="https://app.codacy.com/project/badge/Coverage/e8a7a7448b2043d9bbefafc5a3ec14f7" alt="Codacy Coverage"/></a>
+     <a href="https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml" target="_blank" rel="noopener noreferrer"><img src="https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml/badge.svg?branch=main" alt="Lint Pytest"/></a>
+     <a href="https://ty-cheng.github.io/torchvinecopulib/" target="_blank" rel="noopener noreferrer"><img src="https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/static.yml/badge.svg?branch=main" alt="Deploy Docs"/></a>
      <br/>
      <img src="https://img.shields.io/pypi/pyversions/torchvinecopulib" alt="PyPI - Python Version"/>
-     <img src="https://img.shields.io/badge/OS-Windows%7CmacOS%7CUbuntu-blue" alt="OS"/>
+     <a href="https://github.com/TY-Cheng/torchvinecopulib/actions/workflows/python-package.yml" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/OS-Windows%7CmacOS%7CUbuntu-blue" alt="OS Compatibility"/></a>
      <br/>
-     <a href="https://github.com/TY-Cheng/torchvinecopulib/blob/main/LICENSE"><img src="https://img.shields.io/github/license/ty-cheng/torchvinecopulib" alt="GitHub License"/></a>
-     <a href="https://pypi.org/project/torchvinecopulib/"><img src="https://img.shields.io/pypi/v/torchvinecopulib" alt="PyPI - Version"/></a>
-     <a href="https://zenodo.org/doi/10.5281/zenodo.10836953"><img src="https://zenodo.org/badge/768037665.svg" alt="DOI"/></a>
+     <a href="https://github.com/TY-Cheng/torchvinecopulib/blob/main/LICENSE" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="GitHub License"/></a>
+     <a href="https://pypi.org/project/torchvinecopulib/" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/pypi/v/torchvinecopulib" alt="PyPI - Version"/></a>
+     <a href="https://zenodo.org/doi/10.5281/zenodo.10836953" target="_blank" rel="noopener noreferrer"><img src="https://zenodo.org/badge/768037665.svg" alt="DOI"/></a>
    </p>
 
 ``torchvinecopulib`` is a ``Python`` library for fitting and sampling vine copulas using ``PyTorch``. 

pyproject.toml

@@ -39,7 +39,10 @@ classifiers = [
     "Operating System :: Microsoft :: Windows :: Windows 10",
     "Operating System :: POSIX :: Linux",
     "Operating System :: MacOS",
-    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
     "Topic :: Scientific/Engineering",
 ]
 dependencies = ["numpy>=2", "scipy", "fastkde", "pyvinecopulib"]