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.
Files changed (129) hide show
  1. {sortingview-0.14.2/sortingview.egg-info → sortingview-0.15.0}/PKG-INFO +6 -2
  2. sortingview-0.15.0/README.md +61 -0
  3. {sortingview-0.14.2 → sortingview-0.15.0}/pyproject.toml +7 -1
  4. {sortingview-0.14.2 → sortingview-0.15.0}/setup.cfg +1 -1
  5. sortingview-0.15.0/sortingview/SpikeSortingView/Figure.py +46 -0
  6. sortingview-0.15.0/sortingview/figpack_backend.py +730 -0
  7. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/sortingview_view_url.py +0 -1
  8. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/version.py +1 -1
  9. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SortingCuration2.py +0 -1
  10. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SortingSelection.py +0 -1
  11. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/View.py +7 -0
  12. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/franklab/DecodedLinearPositionV1.py +1 -2
  13. {sortingview-0.14.2 → sortingview-0.15.0/sortingview.egg-info}/PKG-INFO +6 -2
  14. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview.egg-info/SOURCES.txt +1 -2
  15. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview.egg-info/requires.txt +4 -0
  16. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview.egg-info/top_level.txt +1 -0
  17. sortingview-0.14.2/README.md +0 -42
  18. sortingview-0.14.2/gui/node_modules/flatted/python/flatted.py +0 -149
  19. sortingview-0.14.2/gui/node_modules/flatted/python/test.py +0 -63
  20. sortingview-0.14.2/sortingview/SpikeSortingView/Figure.py +0 -25
  21. {sortingview-0.14.2 → sortingview-0.15.0}/LICENSE +0 -0
  22. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_autocorrelograms.py +0 -0
  23. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_average_waveforms.py +0 -0
  24. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_box_layout.py +0 -0
  25. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_confusion_matrix.py +0 -0
  26. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_cross_correlograms.py +0 -0
  27. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_image.py +0 -0
  28. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_markdown.py +0 -0
  29. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_mountain_layout.py +0 -0
  30. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_plotly.py +0 -0
  31. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_position_plot.py +0 -0
  32. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_raster_plot.py +0 -0
  33. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_sorting_curation.py +0 -0
  34. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_spike_amplitudes.py +0 -0
  35. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_spike_locations.py +0 -0
  36. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_splitter_layout.py +0 -0
  37. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_tab_layout.py +0 -0
  38. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_tiled_image.py +0 -0
  39. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_timeseries_graph.py +0 -0
  40. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_track_position_animation.py +0 -0
  41. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_unit_locations.py +0 -0
  42. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_unit_metrics_graph.py +0 -0
  43. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_unit_similarity_matrix.py +0 -0
  44. {sortingview-0.14.2 → sortingview-0.15.0}/examples/example_units_table.py +0 -0
  45. {sortingview-0.14.2 → sortingview-0.15.0}/examples/helpers/compute_correlogram_data.py +0 -0
  46. {sortingview-0.14.2 → sortingview-0.15.0}/examples/helpers/create_units_table.py +0 -0
  47. {sortingview-0.14.2 → sortingview-0.15.0}/setup.py +0 -0
  48. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/MultiTimeseries.py +0 -0
  49. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/SpikeSortingView.py +0 -0
  50. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/__init__.py +0 -0
  51. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_autocorrelograms_view.py +0 -0
  52. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_average_waveforms_view.py +0 -0
  53. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_autocorrelograms.py +0 -0
  54. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_average_waveforms.py +0 -0
  55. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_electrode_geometry.py +0 -0
  56. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_live_cross_correlograms.py +0 -0
  57. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_mountain_layout.py +0 -0
  58. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_raster_plot.py +0 -0
  59. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_spike_amplitudes.py +0 -0
  60. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_summary.py +0 -0
  61. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_create_units_table.py +0 -0
  62. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_cross_correlograms_view.py +0 -0
  63. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_electrode_geometry_view.py +0 -0
  64. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_raster_plot_view.py +0 -0
  65. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_sorting_summary_view.py +0 -0
  66. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_spike_amplitudes_view.py +0 -0
  67. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/_units_table_view.py +0 -0
  68. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_console_view.py +0 -0
  69. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_epochs.py +0 -0
  70. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_position_pdf_plot.py +0 -0
  71. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_position_plot.py +0 -0
  72. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_raw_traces_plot.py +0 -0
  73. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/create_spike_raster_plot.py +0 -0
  74. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/helpers/__init__.py +0 -0
  75. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/helpers/compute_correlogram_data.py +0 -0
  76. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/SpikeSortingView/prepare_spikesortingview_data.py +0 -0
  77. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/__init__.py +0 -0
  78. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Autocorrelograms.py +0 -0
  79. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/AverageWaveforms.py +0 -0
  80. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Box.py +0 -0
  81. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/ConfusionMatrix.py +0 -0
  82. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/CrossCorrelograms.py +0 -0
  83. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/ElectrodeGeometry.py +0 -0
  84. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/EphysTraces.py +0 -0
  85. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Image.py +0 -0
  86. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/LayoutItem.py +0 -0
  87. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Markdown.py +0 -0
  88. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/MountainLayout.py +0 -0
  89. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/PlotlyFigure.py +0 -0
  90. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/PositionPlot.py +0 -0
  91. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/RasterPlot.py +0 -0
  92. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SortingCuration.py +0 -0
  93. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SortingSummary.py +0 -0
  94. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SpikeAmplitudes.py +0 -0
  95. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/SpikeLocations.py +0 -0
  96. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/Splitter.py +0 -0
  97. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/TabLayout.py +0 -0
  98. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/TiledImage.py +0 -0
  99. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/TimeseriesGraph.py +0 -0
  100. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitImages.py +0 -0
  101. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitLocations.py +0 -0
  102. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitMetricsGraph.py +0 -0
  103. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitSimilarityMatrix.py +0 -0
  104. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/UnitsTable.py +0 -0
  105. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/__init__.py +0 -0
  106. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/franklab/TrackPositionAnimationV1.py +0 -0
  107. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview/views/franklab/__init__.py +0 -0
  108. {sortingview-0.14.2 → sortingview-0.15.0}/sortingview.egg-info/dependency_links.txt +0 -0
  109. {sortingview-0.14.2 → sortingview-0.15.0}/tests/helpers/compute_correlogram_data.py +0 -0
  110. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_autocorrelograms.py +0 -0
  111. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_average_waveforms.py +0 -0
  112. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_confusion_matrix.py +0 -0
  113. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_cross_correlograms.py +0 -0
  114. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_large_timeseries_graph.py +0 -0
  115. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_layout.py +0 -0
  116. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_markdown.py +0 -0
  117. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_position_plot.py +0 -0
  118. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_raster_plot.py +0 -0
  119. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_sorting_curation_2.py +0 -0
  120. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_sorting_selection.py +0 -0
  121. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_spike_amplitudes.py +0 -0
  122. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_spike_locations.py +0 -0
  123. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_tab_layout.py +0 -0
  124. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_tiled_image.py +0 -0
  125. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_track_position_animation.py +0 -0
  126. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_unit_locations.py +0 -0
  127. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_unit_metrics_graph.py +0 -0
  128. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_unit_similarity_matrix.py +0 -0
  129. {sortingview-0.14.2 → sortingview-0.15.0}/tests/test_units_table.py +0 -0
@@ -1,6 +1,6 @@
1
- Metadata-Version: 2.1
1
+ Metadata-Version: 2.4
2
2
  Name: sortingview
3
- Version: 0.14.2
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.14.2"
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"
@@ -1,6 +1,6 @@
1
1
  [metadata]
2
2
  name = sortingview
3
- version = 0.14.2
3
+ version = 0.15.0
4
4
  author = Jeremy Magland and Jeff Soules
5
5
  author_email = jmagland@flatironinstitute.org
6
6
  description = Web app for viewing results of ephys spike sorting
@@ -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