Metadata-Version: 2.4
Name: locat
Version: 0.1.4
Summary: Locat identifies marker genes enriched within a compact subset of cells and depleted elsewhere
Keywords: Locat,Localized genes
Author-email: Wes Lewis <wes.lewis@yale.edu>, Fabio Parisi <fabio.parisi@pcmgf.com>, Francesco Strino <francesco.strino@pcmgf.com>, Yuval Kluger <yuval.kluger@yale.edu>
Maintainer-email: Wes Lewis <wes.lewis@yale.edu>, Fabio Parisi <fabio.parisi@pcmgf.com>, Francesco Strino <francesco.strino@pcmgf.com>
Requires-Python: >=3.10
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: License :: OSI Approved :: BSD License
Classifier: Intended Audience :: Science/Research
License-File: LICENSE
Requires-Dist: scanpy
Requires-Dist: loguru
Requires-Dist: jax<0.7
Requires-Dist: tensorflow_probability
Requires-Dist: pytest ; extra == "dev"
Requires-Dist: flit_core ; extra == "dev"
Requires-Dist: flit_scm ; extra == "dev"
Project-URL: Bug Tracker, https://github.com/KlugerLab/Locat/issues
Project-URL: Documentation, https://github.com/KlugerLab/Locat
Project-URL: Repository, https://github.com/KlugerLab/Locat
Provides-Extra: dev

# Locat #
This package is an implementation of Locat. Locat identifies marker genes with
concentrated expression domains while excluding broadly expressed background
genes across diverse biological contexts.

The documentation is available at <https://klugerlab.github.io/Locat>.
Additional code and supporting information for the Locat paper is available at <https://github.com/Klugerlab/Locat-paper>.

## Installation ## 
The main version of the package can be installed as
```
pip install locat
```

The package is based on jax (see [installation instructions](https://docs.jax.dev/en/latest/notebooks/thinking_in_jax.html#installation)). 
To enable jax with GPU or TPU, install jax with cuda support.  
For example, if your system has `cuda12`, install locat as:
```
pip install locat jax[cuda12]
```

The development version of the package can be installed as
```
pip install git+https://github.com/Klugerlab/Locat.git
```

