Metadata-Version: 2.1
Name: fiblat
Version: 0.3.2
Summary: A package for generating evenly distributed points on a sphere
Home-page: https://github.com/erikbrinkman/fibonacci_lattice
License: MIT
Author: Erik Brinkman
Author-email: erik.brinkman@gmail.com
Requires-Python: >=3.8,<3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Requires-Dist: numba (>=0.55.2,<0.56.0)
Requires-Dist: numpy (>=1.18,<1.23)
Project-URL: Repository, https://github.com/erikbrinkman/fibonacci_lattice
Description-Content-Type: text/markdown

Fibonacci Lattice
=================
[![pypi](https://img.shields.io/pypi/v/fiblat)](https://pypi.org/project/fiblat/)
[![build](https://github.com/erikbrinkman/fibonacci_lattice/actions/workflows/build.yml/badge.svg)](https://github.com/erikbrinkman/fibonacci_lattice/actions/workflows/build.yml)

A simple small python package for generating uniform points on the sphere.
This module provides to 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
-----------

- setup: `poetry install`
- tests: `poetry run pytest && poetry run pyre`

