Metadata-Version: 2.4
Name: scatlastb-utils
Version: 0.0.1
Summary: Package for scAtlasTb utils functions
Project-URL: Documentation, https://scAtlasTb-utils.readthedocs.io/
Project-URL: Homepage, https://github.com/mumichae/scAtlasTb-utils
Project-URL: Source, https://github.com/mumichae/scAtlasTb-utils
Author: Michaela Mueller
Maintainer-email: Michaela Mueller <michaela.mueller@helmholtz-munich.de>
License: MIT License
        
        Copyright (c) 2025, Michaela Mueller
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.11
Requires-Dist: anndata>=0.10
Requires-Dist: dask-ml
Requires-Dist: dask<2024.8
Requires-Dist: h5py>=1.14.2
Requires-Dist: leidenalg
Requires-Dist: numpy<2
Requires-Dist: scanpy>=1.9.5
Requires-Dist: scipy<1.15
Requires-Dist: session-info2
Requires-Dist: sparse
Requires-Dist: zarr<3
Description-Content-Type: text/markdown

# scAtlasTb-utils

[![Tests][badge-tests]][tests]
[![Documentation][badge-docs]][documentation]

[badge-tests]: https://img.shields.io/github/actions/workflow/status/mumichae/scAtlasTb-utils/test.yaml?branch=main
[badge-docs]: https://img.shields.io/readthedocs/scAtlasTb-utils

Package for scAtlasTb utils functions

## Getting started

Please refer to the [documentation][],
in particular, the [API documentation][].

## Installation

You need to have Python 3.10 or newer installed on your system.
If you don't have Python installed, we recommend installing [uv][].

There are several alternative options to install scAtlasTb-utils:

<!--
1) Install the latest release of `scAtlasTb-utils` from [PyPI][]:

```bash
pip install scAtlasTb-utils
```
-->

1. Install the latest development version:

```bash
pip install git+https://github.com/mumichae/scAtlasTb-utils.git@main
```

If you plan to use utilities that integrate with Snakemake, install the optional extra:

```bash
pip install 'git+https://github.com/mumichae/scAtlasTb-utils.git@main#egg=scatlastb-utils[snakemake]'
```
or, after cloning locally:

```bash
pip install .[snakemake]
```

## Release notes

See the [changelog][].

## Contact

For questions and help requests, you can reach out in the [scverse discourse][].
If you found a bug, please use the [issue tracker][].

## Citation

> t.b.a

[uv]: https://github.com/astral-sh/uv
[scverse discourse]: https://discourse.scverse.org/
[issue tracker]: https://github.com/mumichae/scAtlasTb-utils/issues
[tests]: https://github.com/mumichae/scAtlasTb-utils/actions/workflows/test.yaml
[documentation]: https://scatlastb-utils.readthedocs.io
[changelog]: https://scatlastb-utils.readthedocs.io/en/latest/changelog.html
[api documentation]: https://scatlastb-utils.readthedocs.io/en/latest/api.html
[pypi]: https://pypi.org/project/scatlastb-utils
