Metadata-Version: 2.5
Name: fiblat
Version: 0.9.0
Summary: A package for generating evenly distributed points on a sphere
Project-URL: homepage, https://hafa.cc/fibonacci_lattice/
Project-URL: documentation, https://hafa.cc/fibonacci_lattice/
Project-URL: repository, https://github.com/hafacc/fibonacci_lattice
License-Expression: MIT
License-File: LICENSE
Keywords: fibonacci,hypersphere,lattice,numpy,sphere
Requires-Python: >=3.13
Requires-Dist: numba>=0.61.0
Requires-Dist: numpy>=2.1.3
Description-Content-Type: text/markdown

# Fibonacci Lattice

[![pypi](https://img.shields.io/pypi/v/fiblat)](https://pypi.org/project/fiblat/)
[![build](https://github.com/hafacc/fibonacci_lattice/actions/workflows/build.yml/badge.svg)](https://github.com/hafacc/fibonacci_lattice/actions/workflows/build.yml)
[![docs](https://img.shields.io/badge/api-docs-blue)](https://hafa.cc/fibonacci_lattice/)

A simple small python package for generating uniform points on the sphere.
This module provides two functions `fiblat.cube_lattice` and `fiblat.sphere_lattice`.
Both functions take a dimension and a number of points and return numpy arrays that are roughly evenly spaced in either the `[0, 1]` hypercube or the unit hypersphere.

## Installation

```bash
pip install fiblat
```

## Usage

```python
from fiblat import sphere_lattice, cube_lattice

cube = cube_lattice(3, 100)
sphere = sphere_lattice(3, 100)
```

## Development

```sh
uv run ruff format --check
uv run ruff check
uv run pyright
uv run pytest
```

Releases run via the `release` workflow (a manual `workflow_dispatch` with a
patch/minor/major bump), which gates, bumps, tags, and publishes to PyPI via OIDC
trusted publishing.
