docs: add DCOR quick guide and update screenshots; fix: support older session files

Author: paulmueller

CHANGELOG

@@ -1,7 +1,9 @@
 2.1.0
  - feat: basic DCOR support
+ - fix: improved session support (older pre-release sessions)
+ - docs: add DCOR guick guide 
  - enh: export event image via context menu in Quick View (#35)
- - setup: bump dclab from 0.21.1 to 0.22.0 (DCOR support)
+ - setup: bump dclab from 0.21.1 to 0.22.1 (DCOR support)
 2.0.3
  - setup: bump dclab from 0.20.3 to 0.21.1
  - docs: add terminology section (#12)

docs/scrots/make_scrots_qg_dcor.py

@@ -0,0 +1,24 @@
+"""Screenshots for quick guide dcor"""
+import sys
+
+from PyQt5 import QtCore
+from PyQt5.QtWidgets import QApplication
+from shapeout2.gui.main import ShapeOut2
+from shapeout2.gui import dcor
+
+app = QApplication(sys.argv)
+
+QtCore.QLocale.setDefault(QtCore.QLocale(QtCore.QLocale.C))
+
+mw = ShapeOut2()
+mw.settings.set_bool("developer mode", False)
+
+# show the dialog
+dlg = dcor.DCORLoader(mw)
+dlg.lineEdit_api_key.setText("")
+dlg.lineEdit_search.setText("reference data")
+dlg.on_search()
+dlg.repaint()
+QApplication.processEvents()
+QApplication.processEvents()
+dlg.grab().save("_qg_dcor_dlg.png")

docs/scrots/qg_dcor_dlg.png

@@ -1,6 +1,5 @@
 .. _sec_qg_batch_stats:
 
-
 ==================
 Compute statistics
 ==================

docs/scrots/ui_ana_filter.png

@@ -0,0 +1,34 @@
+.. _sec_qg_dcor:
+
+===================
+Accessing DCOR data
+===================
+
+The `deformability cytometry open repository (DCOR)
+<https://dcor.mpl.mpg.de>`_ allows you to upload and access RT-DC
+datasets online (internet connection required). In Shape-Out 2, you
+can access parts of the dataset (e.g. just two features) without
+downloading the entire data file (which includes image, contour, and
+traces information). This saves disk space and time when accessing
+large datasets.
+
+.. _qg_dcor_dlg:
+.. figure:: scrots/qg_dcor_dlg.png
+    :target: _images/qg_dcor_dlg.png
+
+    Dialog for loading DCOR data.
+
+In the *File* menu, choose *Load DCOR data*. A dialog 
+(:numref:`qg_dcor_dlg`) lets you search data in the DCOR repository.
+
+.. note::
+
+    If you need to access private data, you have to enter your
+    personal API Key. You can find your personal API Key in your
+    user pofile page after logging in at https://dcor.mpl.mpg.de.
+
+You can choose between a free text search (dataset and resource names,
+tags, etc.) and an identifier search (dataset and resource identifiers).
+After clicking the *Search* button, you may select the resources you
+wish to load into your sesssion in the list view below. Then, click
+*Open* to load the data.

docs/scrots/ui_ana_slot.png

@@ -8,5 +8,6 @@ Quick Guides
 
    sec_qg_consistency_check
    sec_qg_filtering
+   sec_qg_dcor
    sec_qg_youngs_modulus
    sec_qg_batch_stats