Metadata-Version: 2.4
Name: rectanglepy
Version: 1.5.0
Summary: Hierarchical deconvolution of bulk  transcriptomics
Project-URL: Documentation, https://rectanglepy.readthedocs.io/
Project-URL: Source, https://github.com/ComputationalBiomedicineGroup/Rectangle
Project-URL: Home-page, https://github.com/ComputationalBiomedicineGroup/Rectangle
Author: Bernhard Eder
Maintainer-email: Bernhard Eder <Bernhard.Eder@student.uibk.ac.at>
License-Expression: BSD-3-Clause OR LicenseRef-Rectangle-Commercial
License-File: LICENSE
License-File: LICENSE-Commercial.md
Requires-Python: >=3.10
Requires-Dist: anndata<0.10.9,>=0.8.0
Requires-Dist: loguru
Requires-Dist: numpy<2.0.0,>=1.0.0
Requires-Dist: osqp>=1.0.5
Requires-Dist: pandas<3.0.0,>=2.0.0
Requires-Dist: pydeseq2==0.4.11
Requires-Dist: scipy==1.13.0
Requires-Dist: statsmodels>=0.14.1
Provides-Extra: dev
Requires-Dist: bump2version; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: twine>=4.0.2; extra == 'dev'
Provides-Extra: doc
Requires-Dist: furo; extra == 'doc'
Requires-Dist: ipykernel; extra == 'doc'
Requires-Dist: ipython; extra == 'doc'
Requires-Dist: myst-nb; extra == 'doc'
Requires-Dist: sphinx; extra == 'doc'
Requires-Dist: sphinx-autodoc-typehints; extra == 'doc'
Requires-Dist: sphinx-book-theme; extra == 'doc'
Requires-Dist: sphinx-copybutton; extra == 'doc'
Requires-Dist: sphinxcontrib-bibtex; extra == 'doc'
Provides-Extra: test
Requires-Dist: pytest; extra == 'test'
Description-Content-Type: text/markdown

# Rectangle

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

[badge-tests]: https://img.shields.io/github/actions/workflow/status/ComputationalBiomedicineGroup/Rectangle/build.yaml?branch=main
[link-tests]: https://github.com/ComputationalBiomedicineGroup/Rectangle/actions/workflows/build.yaml
[badge-docs]: https://img.shields.io/readthedocs/rectanglepy

Rectangle is an open-source Python package for single-cell-informed cell-type deconvolution of bulk and spatial transcriptomic data, which is part of the [scverse ecosystem](https://scverse.org/packages/).

Rectangle presents a novel approach to second-generation deconvolution, characterized by hierarchical signature building for fine-grained cell-type deconvolution, estimation and correction of unknown cellular content, and efficient handling of large-scale single-cell data during signature matrix computation.

Rectangle was developed to overcome the current challenges in cell-type deconvolution, providing a robust and accurate methodology while ensuring a low computational profile.

## Getting started

Please refer to the [documentation][link-docs]. In particular, the

-   [Tutorials][link-docs/tutorials] for a step-by-step guide on how to use Rectangle, and the

-   [API documentation][link-api].

## Installation

You need Python 3.10–3.12 installed on your system.

How to install Rectangle:

Install the latest release of `Rectangle` from `PyPI` <https://pypi.org/project/rectanglepy/>:

```bash
pip install rectanglepy
```

## License

Rectangle is dual-licensed: BSD-3-Clause OR Commercial.

### Open-source option: BSD-3-Clause

You may use, modify, and redistribute Rectangle, including in proprietary products, if you keep the copyright and license notices and do not use the authors’ names for endorsement.

See [LICENSE](LICENSE).

### Commercial option

For alternative terms, such as warranties, indemnities, dedicated support, SLAs, or redistribution without BSD notice requirements, contact innovation-psb@uibk.ac.at.

See [LICENSE-Commercial.md](LICENSE-Commercial.md).

## Release notes

See the [changelog][changelog].

## Contact

If you found a bug, please use the [issue tracker][issue-tracker].

For commercial licensing: **innovation-psb@uibk.ac.at**

## Citation

> If you use Rectangle in your project, please cite: (TBA)

[scverse-discourse]: https://discourse.scverse.org/
[issue-tracker]: https://github.com/ComputationalBiomedicineGroup/Rectangle/issues
[changelog]: https://rectanglepy.readthedocs.io/changelog.html
[link-docs]: https://Rectanglepy.readthedocs.io
[link-api]: https://rectanglepy.readthedocs.io/api.html
[link-docs/tutorials]: https://rectanglepy.readthedocs.io/notebooks/example.html
