Skip to content

edahelsinki/slisemap_interactive

Repository files navigation

Tests Licence: MIT Code style: black

Slisemap-interactive

Interactive plots for Slisemap using Dash. This package can be used in four different ways:

  1. CLI: To start a standalone dash app just run slisemap_interactive path/to/slisemap/object.sm (if the package has been installed) or python -m slisemap_interactive path/to/slisemap/object.sm (in the root of this repository).

  2. REPL: To use it as (interactive) replacement plots for Slisemap from a Python terminal, import the plot function from slisemap_interactive import plot and use it plot(slisemap_object).

  3. jupyter: To create plots in a jupyter notebook, import the plot function from slisemap_interactive import plot and use it plot(slisemap_object).

  4. χiplot: As a plugin that adds loading and plotting of Slisemap objects. To use the plugin, just install the package in the same Python environment as χiplot.

Screenshots

Screenshot showing focus on a single data item Screenshot showing comparison between clusters

Installation

To install slisemap_interactive run one of the following commands:

pip install slisemap_interactive
pip install slisemap_interactive[xiplot]
pip install git+https://github.com/edahelsinki/slisemap_interactive

Help

To see the syntax and arguments for the command line interface run:

slisemap_interactive --help

To see the arguments for the plot function use the ? in IPython or Jupyter:

from slisemap_interactive import plot
plot?

Development

When developing slisemap_interactive it is a good idea to do an “editable” install. An editable install just links “installed” Python files to the Python files in this directory (so that any changes are immediately available). This takes care of the namespace resolution and also activates the "entry_points" for the standalone CLI and χiplot-plugin. To do an editable installation run:

pip install --editable ".[dev]"