Metadata-Version: 2.4
Name: latan
Version: 2026.7.0
Summary: Statistical data analysis library for lattice field theory
Keywords: lattice field theory,statistical analysis,correlated fitting,bootstrap
Author: Antonin Portelli
Author-email: Antonin Portelli <antonin.portelli@me.com>
License-Expression: GPL-3.0-or-later
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Physics
Requires-Dist: h5py>=3.16.0
Requires-Dist: iminuit>=2.32.0
Requires-Dist: matplotlib>=3.11.0
Requires-Dist: numba>=0.66.0
Requires-Dist: numpy>=2.0,<2.5
Requires-Dist: scipy>=1.18.0
Requires-Python: >=3.12
Project-URL: Homepage, https://github.com/aportelli/latan
Project-URL: Repository, https://github.com/aportelli/latan
Project-URL: Issues, https://github.com/aportelli/latan/issues
Description-Content-Type: text/markdown

# Latan
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)

*Statistical data analysis library for lattice field theory*

Disclaimer: this package is still in early development and is expected to receive significant updates.

## Installation

Latan requires Python 3.12 or later.

```shell
pip install latan
```

## Getting started

The package includes [example notebooks](https://github.com/aportelli/latan/tree/main/notebooks) and interfaces for [public datasets](https://github.com/aportelli/latan/tree/main/latan/datasets).

## Development

[Install uv](https://docs.astral.sh/uv/getting-started/installation/) if you have not already done so. Then, at the root of the repository, execute:
```shell
uv sync
```
This will create a Python environment in `.venv`, which should be used to run code from this repository. This environment can be activated in a shell with
```shell
source .venv/bin/activate
```

## Citation policy

If you use Latan in research that leads to a publication, please cite this repository or the corresponding software release.

If contributors to this repository make a substantial intellectual contribution to your research beyond providing the software, please consider co-authorship in line with standard authorship guidelines.

## AI policy

*Latan is not vibe-coded and does not accept vibe-coded contributions*. Nevertheless, LLMs can be effective productivity tools and have been used at intermediate stages of development, including:

- Mechanical coding tasks, such as find-and-replace or propagation of trivial API changes;
- prototyping, testing, and benchmarking during the early stages of a feature;
- first drafts of API documentation;
- low-stakes plotting helpers.

New contributions must respect the following rules:

- All commits must be authored and submitted by a human contributor, who takes responsibility for the submitted code.
- AI-assisted prototyping is permitted. Before code from such a prototype is imported into Latan, a human contributor must review it end-to-end, understand its behavior, and validate it appropriately.
- Unit tests must be curated and validated by a human. Numerical changes should be compared with a trusted reference or independent implementation where practical.
- Documentation may begin as an AI-assisted draft, but must be reviewed, corrected, and approved by a human contributor.
