Metadata-Version: 2.4
Name: glasz
Version: 0.1.0
Summary: A python package for joint kSZ+GGL analysis modeling. 
Project-URL: Homepage, https://github.com/James11222/glasz
Project-URL: Bug Tracker, https://github.com/James11222/glasz/issues
Project-URL: Discussions, https://github.com/James11222/glasz/discussions
Project-URL: Changelog, https://github.com/James11222/glasz/releases
Author-email: James Sunseri <js7501@princeton.edu>
License: BSD 3-Clause License
        
        Copyright (c) 2025, James Sunseri.
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are met:
        
        * Redistributions of source code must retain the above copyright notice, this
          list of conditions and the following disclaimer.
        
        * Redistributions in binary form must reproduce the above copyright notice,
          this list of conditions and the following disclaimer in the documentation
          and/or other materials provided with the distribution.
        
        * Neither the name of the vector package developers nor the names of its
          contributors may be used to endorse or promote products derived from
          this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
        AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
License-File: LICENSE
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Classifier: Typing :: Typed
Requires-Python: <3.12,>=3.8
Requires-Dist: camb
Requires-Dist: numpy<2
Requires-Dist: pyccl
Requires-Dist: pyyaml
Requires-Dist: scipy<=1.11
Provides-Extra: docs
Requires-Dist: furo>=2023.08.17; extra == 'docs'
Requires-Dist: ipykernel; extra == 'docs'
Requires-Dist: ipython; extra == 'docs'
Requires-Dist: matplotlib; extra == 'docs'
Requires-Dist: myst-parser>=0.13; extra == 'docs'
Requires-Dist: nbconvert; extra == 'docs'
Requires-Dist: nbsphinx; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints; extra == 'docs'
Requires-Dist: sphinx-copybutton; extra == 'docs'
Requires-Dist: sphinx-gallery; extra == 'docs'
Requires-Dist: sphinx>=7.0; extra == 'docs'
Provides-Extra: test
Requires-Dist: pytest-cov>=3; extra == 'test'
Requires-Dist: pytest>=6; extra == 'test'
Description-Content-Type: text/markdown

# glasz

[![Actions Status][actions-badge]][actions-link]
[![codecov](https://codecov.io/gh/James11222/glasz/graph/badge.svg?token=wPP0VytjPl)](https://codecov.io/gh/James11222/glasz)
[![Documentation Status][rtd-badge]][rtd-link]

[![PyPI version][pypi-version]][pypi-link]
[![PyPI platforms][pypi-platforms]][pypi-link]

[![GitHub Discussion][github-discussions-badge]][github-discussions-link]

<!-- SPHINX-START -->

<!-- prettier-ignore-start -->
[actions-badge]:            https://github.com/James11222/glasz/workflows/CI/badge.svg
[actions-link]:             https://github.com/James11222/glasz/actions
[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/glasz
[conda-link]:               https://github.com/conda-forge/glasz-feedstock
[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
[github-discussions-link]:  https://github.com/James11222/glasz/discussions
[pypi-link]:                https://pypi.org/project/glasz/
[pypi-platforms]:           https://img.shields.io/pypi/pyversions/glasz
[pypi-version]:             https://img.shields.io/pypi/v/glasz
[rtd-badge]:                https://readthedocs.org/projects/glasz/badge/?version=latest
[rtd-link]:                 https://glasz.readthedocs.io/en/latest/?badge=latest

<!-- prettier-ignore-end -->

# Installation

This package is installable via `pip`. All one has to do is run

```
$ pip install glasz
```

to install the package into your current environment of choice.

## Development Version

This package uses `pixi` as the default task runner and environment manager. It
is significantly faster than any other competitor on the market (conda,
miniconda, mambda, etc...). To install [`pixi`](https://pixi.sh/latest/), click
on the link and install on your machine. It is very light weight and shouldn't
take long. From there, in this repository run the `pixi install` command and you
will gain a `pixi` environment with this package installed including all of its
dependencies. If you are not familiar with `pixi`, you can use the precomputed
`pixi.lock` file to resolve all dependencies in the creation or modification of
a `conda` environment. You can do this on your machine by running

```
$ pixi project export conda-explicit-spec conda_env_files --ignore-pypi-errors
```

which will create a directory called `conda_env_files` loaded with 3
`conda_spec.txt` files (similar to a `.yaml` but these have all the dependencies
precomputed and locked). Having the dependency conflicts precomputed is
important as `pyccl` is a monstrous library which takes a very long time to
install via `conda`. Take a look at the files, each one corresponds to a
different operating system: linux, mac-OS intel, mac-OS arm (M-chips). Choose
the file which resembles your machine and run the command

```
$ conda create --name ENV_NAME --file conda_env_files/default_{YOUR_SYSTEM}_conda_spec.txt
```

to create a new `conda` environment titled `ENV_NAME`. This environment is a
standard `conda` environment with a development version of `glasz` installed
alongside the dependencies. We provide a `conda_env_files` directory with
precomputed `conda_spec.txt` files from the current `pixi.lock` file
corresponding to the version on the main branch.
