Metadata-Version: 2.1
Name: akey
Version: 0.0.4
Summary: akey
Home-page: https://github.com/dsm-72/akey
Author: dsm-72
Author-email: sumner.magruder@yale.edu
License: Apache Software License 2.0
Keywords: akey extra extras single cell sc scanpy anndata RNA-seq seq
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: Apache Software License
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: atyp
Requires-Dist: psrc
Requires-Dist: nchr
Requires-Dist: nlit
Requires-Dist: chck
Requires-Dist: hasr
Requires-Dist: asto
Requires-Dist: calr
Requires-Dist: fpos
Requires-Dist: ltyp
Provides-Extra: dev
Requires-Dist: pandas ; extra == 'dev'
Requires-Dist: numpy >=1.22 ; extra == 'dev'
Requires-Dist: scipy ; extra == 'dev'
Requires-Dist: anndata ; extra == 'dev'
Requires-Dist: scanpy ; extra == 'dev'
Requires-Dist: scrublet ; extra == 'dev'
Requires-Dist: scprep ; extra == 'dev'
Requires-Dist: phate ; extra == 'dev'
Requires-Dist: magic-impute ; extra == 'dev'
Requires-Dist: graphtools ; extra == 'dev'
Requires-Dist: matplotlib ; extra == 'dev'
Requires-Dist: seaborn ; extra == 'dev'
Requires-Dist: excs ; extra == 'dev'
Requires-Dist: torch ; extra == 'dev'
Requires-Dist: scikit-learn ; extra == 'dev'

# akey

<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

## Developer Guide

### Setup

``` sh
# create conda environment
$ mamba env create -f env.yml

# update conda environment
$ mamba env update -n akey --file env.yml
```

### Install

``` sh
pip install -e .

# install from pypi
pip install akey
```

### nbdev

``` sh
# activate conda environment
$ conda activate akey

# make sure the akey package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to the akey package
$ nbdev_prepare
```

### Publishing

``` sh
# publish to pypi
$ nbdev_pypi

# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'
```

# Usage

## Installation

Install latest from the GitHub
[repository](https://github.com/dsm-72/akey):

``` sh
$ pip install git+https://github.com/dsm-72/akey.git
```

or from [conda](https://anaconda.org/dsm-72/akey)

``` sh
$ conda install -c dsm-72 akey
```

or from [pypi](https://pypi.org/project/akey/)

``` sh
$ pip install akey
```

## Documentation

Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/akey)
[pages](https://dsm-72.github.io/akey/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/akey) and
[pypi](https://pypi.org/project/akey/) respectively.
