# anndash
<!-- 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 anndash --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install anndash
```
### nbdev
``` sh
# activate conda environment
$ conda activate anndash
# make sure the anndash package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the anndash 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/anndash):
``` sh
$ pip install git+https://github.com/dsm-72/anndash.git
```
or from [conda](https://anaconda.org/dsm-72/anndash)
``` sh
$ conda install -c dsm-72 anndash
```
or from [pypi](https://pypi.org/project/anndash/)
``` sh
$ pip install anndash
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/anndash)
[pages](https://dsm-72.github.io/anndash/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/anndash) and
[pypi](https://pypi.org/project/anndash/) respectively.
Using `anndash` to create an interactive dashboard is as easy as:
``` python
from anndash.core import AnnDashboard
adb = AnnDashboard(adata)
adb.run()
```
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/anndash",
"name": "anndash",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "anndash anndata omics genomics transcriptomics pipseq spatial plotly dash",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/9f/35/c67c6168d26692e9444ae947728d074bfb27fba2fd8b9cc6387447e13739/anndash-0.0.9.tar.gz",
"platform": null,
"description": "# anndash\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Developer Guide\n\n### Setup\n\n``` sh\n# create conda environment\n$ mamba env create -f env.yml\n\n# update conda environment\n$ mamba env update -n anndash --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install anndash\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate anndash\n\n# make sure the anndash package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to the anndash package\n$ nbdev_prepare\n```\n\n### Publishing\n\n``` sh\n# publish to pypi\n$ nbdev_pypi\n\n# publish to conda\n$ nbdev_conda --build_args '-c conda-forge'\n$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'\n```\n\n# Usage\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/dsm-72/anndash):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/anndash.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/anndash)\n\n``` sh\n$ conda install -c dsm-72 anndash\n```\n\nor from [pypi](https://pypi.org/project/anndash/)\n\n``` sh\n$ pip install anndash\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/anndash)\n[pages](https://dsm-72.github.io/anndash/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/anndash) and\n[pypi](https://pypi.org/project/anndash/) respectively.\n\nUsing `anndash` to create an interactive dashboard is as easy as:\n\n``` python\nfrom anndash.core import AnnDashboard\n\nadb = AnnDashboard(adata)\nadb.run()\n```\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": null,
"version": "0.0.9",
"project_urls": {
"Homepage": "https://github.com/dsm-72/anndash"
},
"split_keywords": [
"anndash",
"anndata",
"omics",
"genomics",
"transcriptomics",
"pipseq",
"spatial",
"plotly",
"dash"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "249440307c235acc78494d348dfe0850d8fe63935b165ea0cbd8f6976db82a50",
"md5": "c30fd59f9c776ca4cd4d506ee9e391ac",
"sha256": "05acdb5bcfe7669978976f325836db9f23af8f8eda23d00611aa8abb78384931"
},
"downloads": -1,
"filename": "anndash-0.0.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c30fd59f9c776ca4cd4d506ee9e391ac",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24536,
"upload_time": "2024-10-24T17:36:35",
"upload_time_iso_8601": "2024-10-24T17:36:35.407530Z",
"url": "https://files.pythonhosted.org/packages/24/94/40307c235acc78494d348dfe0850d8fe63935b165ea0cbd8f6976db82a50/anndash-0.0.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9f35c67c6168d26692e9444ae947728d074bfb27fba2fd8b9cc6387447e13739",
"md5": "2ef4e9b2b0bcb898b08a4d787b6c5fa6",
"sha256": "5403d18178f45b19bdfecef3c257a99ef341c7e1a6650bb5c55865ec2c191705"
},
"downloads": -1,
"filename": "anndash-0.0.9.tar.gz",
"has_sig": false,
"md5_digest": "2ef4e9b2b0bcb898b08a4d787b6c5fa6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 23358,
"upload_time": "2024-10-24T17:36:36",
"upload_time_iso_8601": "2024-10-24T17:36:36.473840Z",
"url": "https://files.pythonhosted.org/packages/9f/35/c67c6168d26692e9444ae947728d074bfb27fba2fd8b9cc6387447e13739/anndash-0.0.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-24 17:36:36",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "anndash",
"github_not_found": true,
"lcname": "anndash"
}
JSON
