docs: update with latest screenshots

AFM-analysis · Aug 16, 2021 · 55b328e · 55b328e
1 parent 3e1347d
commit 55b328e
Show file tree

Hide file tree

Showing 12 changed files with 20 additions and 15 deletions.
diff --git a/CHANGELOG b/CHANGELOG
@@ -7,7 +7,7 @@
    preprocessing dependencies are not met (#15)
  - enh: visualize contact point estimation algorithms in
    preprocessing tab
- - setup: bump nanite from 2.0.0 to 3.1.0 (improved preprocessing)
+ - setup: bump nanite from 2.0.0 to 3.1.1 (improved preprocessing)
 0.9.4
  - enh: only show exact sneddon model "sneddon_spher" in developer
    mode to avoid confusion

diff --git a/docs/scrots/make_scrots_ui_fd.py b/docs/scrots/make_scrots_ui_fd.py
@@ -54,24 +54,32 @@ def cleanup_autosave(jpkfile):
 QApplication.processEvents()
 war.tabs.grab().save("_ui_fd_tab_preproc.png")
 
+# fit
 war.tabs.setCurrentIndex(1)
 QApplication.processEvents()
 war.tabs.grab().save("_ui_fd_tab_fit.png")
 
+# edelta
 war.tabs.setCurrentIndex(2)
 QApplication.processEvents()
 war.tabs.grab().save("_ui_fd_tab_edelta.png")
 
+# info
 war.tabs.setCurrentIndex(4)
 QApplication.processEvents()
 war.tabs.grab().save("_ui_fd_tab_info.png")
 
+# qmap
+# Select all curves (so QMap is fully visible)
+war.sp_rating_thresh.setValue(0.0)
+war.btn_rating_filter.clicked.emit()
 war.tabs.setCurrentIndex(5)
 war.sp_rating_thresh.setValue(0)
 war.btn_rating_filter.clicked.emit()
 QApplication.processEvents()
 war.tabs.grab().save("_ui_fd_tab_qmap.png")
 
+# plot
 war.tabs.setCurrentIndex(3)
 QApplication.processEvents()
 war.tabs.setFixedSize(war.tabs.sizeHint().width(), 300)

diff --git a/docs/scrots/ui_fd_curve_controls.png b/docs/scrots/ui_fd_curve_controls.png
diff --git a/docs/scrots/ui_fd_main.png b/docs/scrots/ui_fd_main.png
diff --git a/docs/scrots/ui_fd_tab_edelta.png b/docs/scrots/ui_fd_tab_edelta.png
diff --git a/docs/scrots/ui_fd_tab_fit.png b/docs/scrots/ui_fd_tab_fit.png
diff --git a/docs/scrots/ui_fd_tab_info.png b/docs/scrots/ui_fd_tab_info.png
diff --git a/docs/scrots/ui_fd_tab_preproc.png b/docs/scrots/ui_fd_tab_preproc.png
diff --git a/docs/scrots/ui_fd_tab_qmap.png b/docs/scrots/ui_fd_tab_qmap.png
diff --git a/docs/sec_getting_started.rst b/docs/sec_getting_started.rst
@@ -15,7 +15,7 @@ PyJibe can be installed via multiple channels:
    (``PyJibeApp_X.Y.Z.dmg``) from the official
    `release page <https://github.com/AFM-analysis/PyJibe/releases/latest>`__. 
 
-3. **Python 3.6 with pip:** PyJibe can easily be installed with
+3. **Python 3.6 or later with pip:** PyJibe can easily be installed with
    `pip <https://pip.pypa.io/en/stable/quickstart/>`__:
 
    .. code:: bash

diff --git a/docs/sec_interface.rst b/docs/sec_interface.rst
@@ -55,17 +55,14 @@ Tab: Preprocess
     :scale: 65%
 
 Before starting to fit FD data, it is important to perform the correct
-steps. Usually, this includes computing the tip position and correcting
-for a force and tip position offset. The offset corrections are only
-necessary for visualization purposes - Force offset and contact point
-are usually free fitting parameters.
+preprocessing steps. Usually, this includes computing the tip position
+and correcting for a force and tip position offset.
 
-To define a new preprocessing pipeline, click on *Clear Preprocessing*
-at the top of the panel. You may either load predefined presets or
-compile your own preprocessing pipeline via drag&drop from the *Available*
-to the *Applied* list controls. When selecting a preprocessing item in
-on of the list controls, its description is shown in the text control
-at the center.
+The preprocessing pipeline is defined via the checkable options in this
+tab. If you hover over the options, a tool tip is displayed with an
+explanation. If your analysis pipeline strongly depends on a good
+estimate of the contact point, then you have multiple options which are
+described in detail in the :ref:`nanite docs<nanite:sec_fitting_preproc>`.
 
 
 .. _sec_ui_fd_tab_fit:
@@ -83,7 +80,7 @@ and the fitting range.
 
 Range:
     The fitting range can be set to absolute (relative to
-    the X axis after preprocessing or relative to the contact point. In the
+    the X axis after preprocessing) or relative to the contact point. In the
     latter case, the fit is repeated four times, updating the new contact
     point at each iteration.
     You have three option for setting the indentation depth (left part

diff --git a/setup.py b/setup.py
@@ -24,8 +24,8 @@
     license="GPL v3",
     description=description,
     long_description=open('README.rst').read() if exists('README.rst') else '',
-    install_requires=["afmformats>=0.16.0",
-                      "nanite>=3.0.0",
+    install_requires=["afmformats>=0.16.4",
+                      "nanite>=3.1.1",
                       "matplotlib>=3",  # NavigationToolbar2QT mod
                       "pyqt5"],
     python_requires='>=3.6, <4',