mirror of
https://github.com/chanzuckerberg/cellxgene.git
synced 2026-09-22 13:28:12 +08:00
Sidney Bell
77ca5c267e
* Update readme * Add demo gif * Update README.md * Update README.md * Update README.md * Update README.md * Update README.md
69 lines
3.0 KiB
Markdown
69 lines
3.0 KiB
Markdown
# cellxgene
|
||
|
||
### An interactive, performant explorer for single cell transcriptomics data.
|
||
|
||
<img align="right" width="350" height="218" src="./example-dataset/cellxgene-demo.gif" pad="50px">
|
||
cellxgene is an open-source experiment in how to bring powerful tools from modern web development to visualize and explore large single-cell transcriptomics datasets.
|
||
Started in the context of the Human Cell Atlas Consortium, cellxgene hopes to both enable scientists to explore their data and to equip developers with scalable, reusable patterns and frameworks for visualizing large scientific datasets.
|
||
|
||
## Features
|
||
|
||
* **Visualization at scale:** built with [WebGL](https://www.khronos.org/webgl/), [React](https://reactjs.org/) & [Redux](https://redux.js.org/) to handle visualization of at least 1 million cells.
|
||
|
||
* **Interactive exploration:** select, cross-filter, and compare subsets of your data with performant indexing and data handling.
|
||
|
||
* **Flexible API:** the cellxgene client-server model is designed to support a range of existing analysis packages for backend computational tasks (eg scanpy), integrated with client-side visualization via a [REST API](https://restfulapi.net/).
|
||
|
||
|
||
## Getting Started
|
||
|
||
**Requirements**
|
||
- OS: OSX, Windows, Linux
|
||
- python 3.6
|
||
- npm
|
||
- Google Chrome
|
||
|
||
**Clone project**
|
||
|
||
git clone https://github.com/chanzuckerberg/cellxgene.git
|
||
|
||
**Install client**
|
||
|
||
cd cellxgene
|
||
./bin/build-client
|
||
|
||
**To use with virtual env for python**
|
||
(optional, but recommended)
|
||
|
||
ENV_NAME=cellxgene
|
||
python3 -m venv ${ENV_NAME}
|
||
source ${ENV_NAME}/bin/activate
|
||
|
||
**Install server**
|
||
|
||
python3 setup.py install
|
||
|
||
**Run (with demo data)**
|
||
|
||
cellxgene --title PBMC3K scanpy example-dataset/
|
||
*In google chrome, navigate to the viewer via the web address printed in your console.
|
||
E.g.,* `Running on http://0.0.0.0:5005/`
|
||
|
||
**Help**
|
||
|
||
cellxgene --help
|
||
_For help with the scanpy engine_
|
||
|
||
cellxgene scanpy --help
|
||
|
||
## Contributing
|
||
We warmly welcome contributions from the community. Please submit any bug reports and feature requests through github issues. Please submit any direct contributions via a branch + pull request.
|
||
|
||
## Inspiration and collaboration
|
||
We’ve been inspired by several other related efforts in this space, including the [UCSC Cell Browswer](http://cells.ucsc.edu/), [Cytoscape](http://www.cytoscape.org/), [Xena](https://xena.ucsc.edu/), [ASAP](https://asap.epfl.ch/), [Gene Pattern](http://genepattern-notebook.org/), & many others; we hope to explore collaborations where useful.
|
||
|
||
## Reuse
|
||
This project was started with the sole goal of empowering the scientific community to explore and understand their data. As such, we whole-heartedly encourage other scientific tool builders to adopt the patterns, tools, and code from this project, and reach out to us with ideas or questions using Github Issues or Pull Requests. All code is freely available for reuse under the [MIT license](https://opensource.org/licenses/MIT).
|
||
|
||
*We thank Alex Wolf for the demo dataset.*
|