sortingview 0.14.2__tar.gz → 0.15.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {sortingview-0.14.2/sortingview.egg-info → sortingview-0.15.0}/PKG-INFO +6 -2
- sortingview-0.15.0/README.md +61 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/pyproject.toml +7 -1
- {sortingview-0.14.2 → sortingview-0.15.0}/setup.cfg +1 -1
- sortingview-0.15.0/sortingview/SpikeSortingView/Figure.py +46 -0
- sortingview-0.15.0/sortingview/figpack_backend.py +730 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/sortingview_view_url.py +0 -1
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/version.py +1 -1
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SortingCuration2.py +0 -1
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SortingSelection.py +0 -1
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/View.py +7 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/franklab/DecodedLinearPositionV1.py +1 -2
- {sortingview-0.14.2 → sortingview-0.15.0/sortingview.egg-info}/PKG-INFO +6 -2
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview.egg-info/SOURCES.txt +1 -2
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview.egg-info/requires.txt +4 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview.egg-info/top_level.txt +1 -0
- sortingview-0.14.2/README.md +0 -42
- sortingview-0.14.2/gui/node_modules/flatted/python/flatted.py +0 -149
- sortingview-0.14.2/gui/node_modules/flatted/python/test.py +0 -63
- sortingview-0.14.2/sortingview/SpikeSortingView/Figure.py +0 -25
- {sortingview-0.14.2 → sortingview-0.15.0}/LICENSE +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_autocorrelograms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_average_waveforms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_box_layout.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_confusion_matrix.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_cross_correlograms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_image.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_markdown.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_mountain_layout.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_plotly.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_position_plot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_raster_plot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_sorting_curation.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_spike_amplitudes.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_spike_locations.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_splitter_layout.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_tab_layout.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_tiled_image.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_timeseries_graph.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_track_position_animation.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_unit_locations.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_unit_metrics_graph.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_unit_similarity_matrix.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_units_table.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/helpers/compute_correlogram_data.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/examples/helpers/create_units_table.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/setup.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/MultiTimeseries.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/SpikeSortingView.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/__init__.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_autocorrelograms_view.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_average_waveforms_view.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_autocorrelograms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_average_waveforms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_electrode_geometry.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_live_cross_correlograms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_mountain_layout.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_raster_plot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_spike_amplitudes.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_summary.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_units_table.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_cross_correlograms_view.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_electrode_geometry_view.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_raster_plot_view.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_sorting_summary_view.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_spike_amplitudes_view.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_units_table_view.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_console_view.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_epochs.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_position_pdf_plot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_position_plot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_raw_traces_plot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_spike_raster_plot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/helpers/__init__.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/helpers/compute_correlogram_data.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/prepare_spikesortingview_data.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/__init__.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Autocorrelograms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/AverageWaveforms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Box.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/ConfusionMatrix.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/CrossCorrelograms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/ElectrodeGeometry.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/EphysTraces.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Image.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/LayoutItem.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Markdown.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/MountainLayout.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/PlotlyFigure.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/PositionPlot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/RasterPlot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SortingCuration.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SortingSummary.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SpikeAmplitudes.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SpikeLocations.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Splitter.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/TabLayout.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/TiledImage.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/TimeseriesGraph.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitImages.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitLocations.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitMetricsGraph.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitSimilarityMatrix.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitsTable.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/__init__.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/franklab/TrackPositionAnimationV1.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/franklab/__init__.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/sortingview.egg-info/dependency_links.txt +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/helpers/compute_correlogram_data.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_autocorrelograms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_average_waveforms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_confusion_matrix.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_cross_correlograms.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_large_timeseries_graph.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_layout.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_markdown.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_position_plot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_raster_plot.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_sorting_curation_2.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_sorting_selection.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_spike_amplitudes.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_spike_locations.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_tab_layout.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_tiled_image.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_track_position_animation.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_unit_locations.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_unit_metrics_graph.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_unit_similarity_matrix.py +0 -0
- {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_units_table.py +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
Metadata-Version: 2.
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
2
|
Name: sortingview
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.15.0
|
|
4
4
|
Summary: Web app for viewing results of ephys spike sorting
|
|
5
5
|
Home-page: https://github.com/magland/sortingview
|
|
6
6
|
Author: Jeff Soules
|
|
@@ -19,3 +19,7 @@ Requires-Dist: click
|
|
|
19
19
|
Requires-Dist: pynwb
|
|
20
20
|
Requires-Dist: pyyaml
|
|
21
21
|
Requires-Dist: h5py
|
|
22
|
+
Provides-Extra: figpack
|
|
23
|
+
Requires-Dist: figpack<0.5,>=0.4.6; extra == "figpack"
|
|
24
|
+
Requires-Dist: figpack_spike_sorting>=0.1.18; extra == "figpack"
|
|
25
|
+
Dynamic: license-file
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
# SortingView
|
|
2
|
+
|
|
3
|
+
View, curate, and share results of electrophysiological spike sorting in the browser, on the desktop, and in the notebook.
|
|
4
|
+
|
|
5
|
+
[List of examples](./doc/examples.md)
|
|
6
|
+
|
|
7
|
+
[Using layouts](./doc/layouts.md)
|
|
8
|
+
|
|
9
|
+
## Installation and setup
|
|
10
|
+
|
|
11
|
+
```bash
|
|
12
|
+
pip install --upgrade sortingview
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
## Kachery Setup
|
|
16
|
+
|
|
17
|
+
In order to use sortingview, you must configure kachery in order to share files on the kachery network.
|
|
18
|
+
|
|
19
|
+
Visit this site to register and obtain an API key:
|
|
20
|
+
|
|
21
|
+
https://kachery.vercel.app
|
|
22
|
+
|
|
23
|
+
Then set the following environment variables
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
export KACHERY_API_KEY = "the-api-key"
|
|
27
|
+
export KACHERY_ZONE = "default"
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
For information about kachery storage and zones, see:
|
|
31
|
+
|
|
32
|
+
https://github.com/magland/kachery?tab=readme-ov-file#zones-and-storage
|
|
33
|
+
|
|
34
|
+
## Getting started
|
|
35
|
+
|
|
36
|
+
See the [examples folder](./examples).
|
|
37
|
+
|
|
38
|
+
For example:
|
|
39
|
+
|
|
40
|
+
```bash
|
|
41
|
+
python examples/example_autocorrelograms.py
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
## Publishing to figpack instead of figurl (experimental)
|
|
45
|
+
|
|
46
|
+
Existing code that calls `view.url(...)` (for example spyglass) can publish to [figpack](https://github.com/flatironinstitute/figpack) without code changes:
|
|
47
|
+
|
|
48
|
+
```bash
|
|
49
|
+
pip install "sortingview[figpack]"
|
|
50
|
+
export SORTINGVIEW_BACKEND=figpack
|
|
51
|
+
export FIGPACK_API_KEY=... # your figpack API key
|
|
52
|
+
export FIGPACK_BUCKET=... # optional: a bucket whose figures do not expire
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
For the Frank Lab track animation and the 1D decoded position views, also install the figpack extensions:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
figpack extensions install figpack_franklab figpack_experimental
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
`view.url(...)` then returns a figpack figure URL. If the view tree contains a view with no figpack equivalent, sortingview warns and falls back to figurl (set `SORTINGVIEW_FIGPACK_STRICT=1` to raise instead). A starting curation passed as `state={"sortingCuration": uri}` is loaded into the figpack figure, and `sortingview.figpack_backend.load_curation(figure_url)` reads the saved curation back. Set `SORTINGVIEW_FIGPACK_MODE=local` to write the figure to a local folder instead of uploading, or `ephemeral` for a temporary upload that needs no API key.
|
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "sortingview"
|
|
7
|
-
version = "0.
|
|
7
|
+
version = "0.15.0"
|
|
8
8
|
description = "Web app for viewing results of ephys spike sorting"
|
|
9
9
|
authors = [
|
|
10
10
|
{ name="Jeremy Magland", email="jmagland@flatironinstitute.org" },
|
|
@@ -26,6 +26,12 @@ classifiers = [
|
|
|
26
26
|
"Operating System :: OS Independent",
|
|
27
27
|
]
|
|
28
28
|
|
|
29
|
+
[project.optional-dependencies]
|
|
30
|
+
figpack = [
|
|
31
|
+
"figpack>=0.4.6,<0.5",
|
|
32
|
+
"figpack_spike_sorting>=0.1.18",
|
|
33
|
+
]
|
|
34
|
+
|
|
29
35
|
[project.urls]
|
|
30
36
|
Homepage = "https://github.com/magland/sortingview"
|
|
31
37
|
Issues = "https://github.com/magland/sortingview/issues"
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
import weakref
|
|
2
|
+
from typing import Any, Optional
|
|
3
|
+
import figurl as fig
|
|
4
|
+
from ..sortingview_view_url import sortingview_view_url
|
|
5
|
+
|
|
6
|
+
# Figures created in this process, so the figpack backend can convert a legacy
|
|
7
|
+
# MountainLayout (which only references its children by kachery hash) from the
|
|
8
|
+
# children's original data
|
|
9
|
+
_live_figures: "weakref.WeakSet[Figure]" = weakref.WeakSet()
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class Figure:
|
|
13
|
+
def __init__(self, *, data: Any, label: str) -> None:
|
|
14
|
+
self._data = data
|
|
15
|
+
self._label = label
|
|
16
|
+
# important to define the figure here - because it does the check to see if the data is too large
|
|
17
|
+
self._figure = fig.Figure(view_url=sortingview_view_url, data=self._data)
|
|
18
|
+
_live_figures.add(self)
|
|
19
|
+
|
|
20
|
+
def url(self):
|
|
21
|
+
from .. import figpack_backend
|
|
22
|
+
|
|
23
|
+
if figpack_backend.use_figpack():
|
|
24
|
+
# SORTINGVIEW_BACKEND=figpack: publish to figpack instead of figurl
|
|
25
|
+
figpack_url = figpack_backend.try_figpack_url_legacy(self)
|
|
26
|
+
if figpack_url is not None:
|
|
27
|
+
return figpack_url
|
|
28
|
+
return self._figure.url(label=self._label)
|
|
29
|
+
|
|
30
|
+
def get_serialized_figure_data(self):
|
|
31
|
+
return self._figure._serialized_data
|
|
32
|
+
|
|
33
|
+
@property
|
|
34
|
+
def data(self):
|
|
35
|
+
return self._data
|
|
36
|
+
|
|
37
|
+
@property
|
|
38
|
+
def label(self):
|
|
39
|
+
return self._label
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
def find_live_figure(*, type: Optional[str], label: Optional[str]) -> Optional[Figure]:
|
|
43
|
+
for f in list(_live_figures):
|
|
44
|
+
if isinstance(f.data, dict) and f.data.get("type") == type and f.label == label:
|
|
45
|
+
return f
|
|
46
|
+
return None
|