diff --git a/README.md b/README.md index 672ecaa..1539c9e 100644 --- a/README.md +++ b/README.md @@ -23,20 +23,17 @@ SCOUTS is available as a: * GitHub repository - download/clone the repository * binary release (experimental) -For any installation option (other than the binary release), SCOUTS requires **Python >= 3.6**. - Full installation instructions [are found here](https://scouts.readthedocs.io/en/master/install.html). -### Basic usage -The `scouts` package include two user interfaces: -* **SCOUTS**: used to select outliers in a population of single-cells. -* **SCOUTS-violins** (optional): used to visually inspect outliers selected by SCOUTS. +Binary releases [are found here](https://github.com/jfaccioni/scouts/releases). Keep in mind that these are experimental, and may not work properly on your system. In this case, we recommend following another installation method. -#### Using SCOUTS -[Here's a quick rundown of SCOUTS](https://scouts.readthedocs.io/en/master/start.html#using-scouts). +For any installation option (other than the binary release), SCOUTS requires **Python >= 3.6**. -#### Using SCOUTS-violins -[Here's a quick rundown of SCOUTS-violins](https://scouts.readthedocs.io/en/master/start.html#using-scouts-violins). +### Basic usage +The `scouts` package include two user interfaces: +* **SCOUTS**: used to select outliers in a population of single-cells. +[Here's a quick rundown of how to use SCOUTS](https://scouts.readthedocs.io/en/master/start.html#using-scouts). +* **SCOUTS-violins** (optional): used to visually inspect outliers selected by SCOUTS. [Here's a quick rundown of how to use SCOUTS-violins](https://scouts.readthedocs.io/en/master/start.html#using-scouts-violins). ## Documentation [Read the full documentation here](https://scouts.readthedocs.io/en/master/). diff --git a/doc/_static/gui/scouts-workflow.svg b/doc/_static/gui/scouts-workflow.svg new file mode 100644 index 0000000..6079bd4 --- /dev/null +++ b/doc/_static/gui/scouts-workflow.svg @@ -0,0 +1,2735 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Whole population SCOUTS Outliers + + + SCOUTS-violins Visually inspect ouliers + + + + + + diff --git a/doc/_static/scouts-workflow.png b/doc/_static/scouts-workflow.png new file mode 100644 index 0000000..c48ec87 Binary files /dev/null and b/doc/_static/scouts-workflow.png differ