Metadata-Version: 2.4
Name: LSSlab
Version: 0.1.0
Summary: Cosmological Large-Scale Structure Analysis Lab.
Author-email: Siyi Zhao <siyizhao17@gmail.com>
License: BSD 3-Clause License
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Requires-Dist: numpy<1.25,>=1.22
Description-Content-Type: text/markdown

# LSSlab

LSSlab is a Python toolkit collection for the analysis of Cosmological Large-Scale Structure (LSS).

*Let our Universe be a big Lab!* 

## Installation (local dev)

```
python -m pip install -e .
```

### Recommended: isolated env

```
python -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade pip
python -m pip install -e .
python -m pytest
```

### Scripts with extra deps

Some helper scripts in `scripts/` may require additional packages (e.g., cutsky prep). Keep those dependencies in a separate environment. See `docs/extra-deps.md` for notes.

## Usage

```python
import lsslab

print(lsslab.__version__)
```

## Development

- Tooling (one-time): `python -m pip install --upgrade build twine`
- Build: `python -m build`
- Check artifacts: `python -m twine check dist/*`

## License

BSD-3-Clause (see LICENSE)
