<!-- [](https://pypi.org/project/slisemap_interactive/) -->
[](https://github.com/edahelsinki/slisemap_interactive/actions/workflows/python-pytest.yml)
[](https://github.com/edahelsinki/slisemap_interactive/blob/master/LICENSE)
[](https://github.com/psf/black)
# [Slisemap](https://github.com/edahelsinki/slisemap)-interactive
Interactive plots for [Slisemap](https://github.com/edahelsinki/slisemap) using [Dash](https://dash.plotly.com/). 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](https://github.com/edahelsinki/xiplot):__ 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](https://github.com/edahelsinki/xiplot).
## Screenshots
## Installation
To install __slisemap_interactive__ run one of the following commands:
```bash
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:
```bash
slisemap_interactive --help
```
To see the arguments for the plot function use the `?` in IPython or Jupyter:
```python
from slisemap_interactive import plot
plot?
```
## Development
When developing __slisemap_interactive__ it is a good idea to do an “[editable](https://setuptools.pypa.io/en/latest/userguide/development_mode.html)” 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](https://setuptools.pypa.io/en/latest/userguide/entry_point.html)" for the *standalone CLI* and *χiplot-plugin*.
To do an editable installation run:
```bash
pip install --editable ".[dev]"
```
Raw data
{
"_id": null,
"home_page": "",
"name": "slisemap-interactive",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "Slisemap,XAI,visualization,interactive",
"author": "",
"author_email": "Anton Bj\u00f6rklund <anton.bjorklund@helsinki.fi>",
"download_url": "https://files.pythonhosted.org/packages/b4/26/b2c0c0c3a96341ec2c31b2270c8cbbca56ab4743709e13b2b114a300da5d/slisemap_interactive-0.6.0.tar.gz",
"platform": null,
"description": "<!-- [](https://pypi.org/project/slisemap_interactive/) -->\n[](https://github.com/edahelsinki/slisemap_interactive/actions/workflows/python-pytest.yml)\n[](https://github.com/edahelsinki/slisemap_interactive/blob/master/LICENSE)\n[](https://github.com/psf/black)\n# [Slisemap](https://github.com/edahelsinki/slisemap)-interactive\n\nInteractive plots for [Slisemap](https://github.com/edahelsinki/slisemap) using [Dash](https://dash.plotly.com/). This package can be used in four different ways:\n\n1. __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).\n\n2. __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)`.\n\n3. __jupyter:__ To create plots in a jupyter notebook, import the *plot* function `from slisemap_interactive import plot` and use it `plot(slisemap_object)`.\n\n\n4. __[\u03c7iplot](https://github.com/edahelsinki/xiplot):__ As a plugin that adds loading and plotting of Slisemap objects.\nTo use the plugin, just install the package in the same Python environment as [\u03c7iplot](https://github.com/edahelsinki/xiplot).\n\n## Screenshots\n\n\n\n\n## Installation\n\nTo install __slisemap_interactive__ run one of the following commands:\n\n```bash\npip install slisemap_interactive\npip install slisemap_interactive[xiplot]\npip install git+https://github.com/edahelsinki/slisemap_interactive\n```\n\n## Help\n\nTo see the syntax and arguments for the command line interface run:\n\n```bash\nslisemap_interactive --help\n```\n\nTo see the arguments for the plot function use the `?` in IPython or Jupyter:\n\n```python\nfrom slisemap_interactive import plot\nplot?\n```\n\n## Development\n\nWhen developing __slisemap_interactive__ it is a good idea to do an \u201c[editable](https://setuptools.pypa.io/en/latest/userguide/development_mode.html)\u201d install.\nAn editable install just links \u201cinstalled\u201d Python files to the Python files in this directory (so that any changes are immediately available).\nThis takes care of the namespace resolution and also activates the \"[entry_points](https://setuptools.pypa.io/en/latest/userguide/entry_point.html)\" for the *standalone CLI* and *\u03c7iplot-plugin*.\nTo do an editable installation run:\n\n```bash\npip install --editable \".[dev]\"\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Interactive plots for Slisemap using Dash",
"version": "0.6.0",
"project_urls": {
"github": "https://github.com/edahelsinki/slisemap_interactive"
},
"split_keywords": [
"slisemap",
"xai",
"visualization",
"interactive"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "6544bf74e1b844b411d891a0b34168c1ec7848cf146624f423f0d533ee2330f4",
"md5": "90cc334c03709470b721664c3b42e961",
"sha256": "a5c148c3b6ce4ae699101c78c0a1400589b31e76c1e762532ab25393ebb1dc7d"
},
"downloads": -1,
"filename": "slisemap_interactive-0.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "90cc334c03709470b721664c3b42e961",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 23603,
"upload_time": "2024-02-20T13:41:29",
"upload_time_iso_8601": "2024-02-20T13:41:29.896143Z",
"url": "https://files.pythonhosted.org/packages/65/44/bf74e1b844b411d891a0b34168c1ec7848cf146624f423f0d533ee2330f4/slisemap_interactive-0.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b426b2c0c0c3a96341ec2c31b2270c8cbbca56ab4743709e13b2b114a300da5d",
"md5": "84181db3ab654b353b9ec480c6d77e55",
"sha256": "fd1268c6ffbd8bbf2a0fce4397edf477eda306482d54141bbd509abb02fdb6e5"
},
"downloads": -1,
"filename": "slisemap_interactive-0.6.0.tar.gz",
"has_sig": false,
"md5_digest": "84181db3ab654b353b9ec480c6d77e55",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 25650,
"upload_time": "2024-02-20T13:41:33",
"upload_time_iso_8601": "2024-02-20T13:41:33.743713Z",
"url": "https://files.pythonhosted.org/packages/b4/26/b2c0c0c3a96341ec2c31b2270c8cbbca56ab4743709e13b2b114a300da5d/slisemap_interactive-0.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-20 13:41:33",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "edahelsinki",
"github_project": "slisemap_interactive",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "slisemap-interactive"
}
JSON
