Merge pull request #19 from wpfff/cleanup/data

Cleanup/data
toolsforexperiments · Jan 19, 2019 · cc09501 · cc09501
2 parents 00083ea + f565f06
commit cc09501
Show file tree

Hide file tree

Showing 20 changed files with 1,578 additions and 463 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@
 *.egg-info
 __pycache__
 *.egg-info/
-.idea/
+.idea/
+doc/build
diff --git a/README.md b/README.md
@@ -1,25 +1,30 @@
-# plottr: modular plotting and processing
+# plottr: modular data plotting and processing
 
-A framework for inspecting data, based on flowcharts from *pyqtgraph*. 
+A framework for inspecting data, based on flowcharts from *pyqtgraph*.
 *plottr*'s main aim is to allow the user to define custom data processing flows and plotting.
 A particular use case is data filtering and plotting.
 
-## Interactive usage: 
+## Quickstart
 
-For now, check out the Notebook *Interactive data inspection* under `/doc/`.
+### Installation
 
-## inspectr: QCoDeS dataset inspection and live plotting
+In brief: clone the repo, and install using `pip install -e`
 
-You can use the inspectr tool to get a simple overview over QCoDeS database 
+### inspectr: QCoDeS dataset inspection and (live) plotting
+
+You can use the inspectr tool to get a simple overview over QCoDeS database
 files, and plot datasets contained in the database.
 
-### Usage:
+To use: from within the plottr-directory, run `python apps/inspectr.py --dbpath <path to your .db file>`
+
+For basic instructions, check out the Notebook *Live plotting qcodes data* under `/doc/examples`.
 
-* from within the plottr-directory, run `python apps/inspectr.py --dbpath <path to your .db file>`
+### Interactive usage
 
-For more basic instructions, check out the Notebook *Live plotting qcodes data* under `/doc/`.
+For now, check out the Notebook *Interactive data inspection* under `/doc/examples/`.
 
-## Installation
+
+## Some notes on installing
 
 Note: this package is not compatible with the original plottr tool. You might want to install freshly if you still use the old version.
 
@@ -32,8 +37,7 @@ Note: this package is not compatible with the original plottr tool. You might wa
 
 ### python package
 
-clone the repo, and install using `pip -e plottr/`. 
-
+clone the repo, and install using `pip install -e plottr/`.
 
 ## If you're looking for the 'original' plottr package...
 

diff --git a/doc/Makefile b/doc/Makefile
@@ -0,0 +1,19 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/...tion -- data selection and autoplot.ipynb → ...tion -- data selection and autoplot.ipynb b/...tion -- data selection and autoplot.ipynb → ...tion -- data selection and autoplot.ipynb
@@ -53,8 +53,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:48:54.328463Z",
-     "start_time": "2019-01-01T20:48:53.109695Z"
+     "end_time": "2019-01-19T22:02:48.673910Z",
+     "start_time": "2019-01-19T22:02:47.409260Z"
     }
    },
    "outputs": [],
@@ -85,8 +85,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:46:05.041115Z",
-     "start_time": "2019-01-01T20:46:04.951376Z"
+     "end_time": "2019-01-19T21:59:13.750520Z",
+     "start_time": "2019-01-19T21:59:13.655769Z"
     }
    },
    "outputs": [],
@@ -110,8 +110,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:46:06.713661Z",
-     "start_time": "2019-01-01T20:46:06.688728Z"
+     "end_time": "2019-01-19T21:59:18.867317Z",
+     "start_time": "2019-01-19T21:59:18.856352Z"
     }
    },
    "outputs": [],
@@ -146,8 +146,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:46:23.234324Z",
-     "start_time": "2019-01-01T20:46:23.091705Z"
+     "end_time": "2019-01-19T21:58:51.205045Z",
+     "start_time": "2019-01-19T21:58:51.115283Z"
     }
    },
    "outputs": [],
@@ -173,8 +173,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:47:00.388194Z",
-     "start_time": "2019-01-01T20:47:00.382236Z"
+     "end_time": "2019-01-19T21:59:24.365648Z",
+     "start_time": "2019-01-19T21:59:24.361658Z"
     }
    },
    "outputs": [],
@@ -188,8 +188,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:47:19.849186Z",
-     "start_time": "2019-01-01T20:47:19.509967Z"
+     "end_time": "2019-01-19T21:59:26.630587Z",
+     "start_time": "2019-01-19T21:59:26.409060Z"
     }
    },
    "outputs": [],
@@ -216,8 +216,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:47:44.526047Z",
-     "start_time": "2019-01-01T20:47:44.468224Z"
+     "end_time": "2019-01-19T21:59:32.332629Z",
+     "start_time": "2019-01-19T21:59:32.290727Z"
     }
    },
    "outputs": [],
@@ -268,8 +268,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:48:57.926751Z",
-     "start_time": "2019-01-01T20:48:57.921765Z"
+     "end_time": "2019-01-19T22:02:55.128201Z",
+     "start_time": "2019-01-19T22:02:55.123214Z"
     }
    },
    "outputs": [],
@@ -303,8 +303,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:48:59.304572Z",
-     "start_time": "2019-01-01T20:48:58.979377Z"
+     "end_time": "2019-01-19T22:02:56.382449Z",
+     "start_time": "2019-01-19T22:02:56.069043Z"
     },
     "scrolled": true
    },
@@ -353,8 +353,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:49:02.880483Z",
-     "start_time": "2019-01-01T20:49:02.791749Z"
+     "end_time": "2019-01-19T22:02:58.536663Z",
+     "start_time": "2019-01-19T22:02:58.449894Z"
     }
    },
    "outputs": [],
@@ -381,10 +381,10 @@
     "xyselDock.addWidget(xysel.ui)\n",
     "area.addDock(xyselDock, 'bottom')\n",
     "\n",
-    "# log\n",
-    "logDock = Dock('Log', size=(250, 100))\n",
-    "logDock.addWidget(plottrlog.setupLogging(makeDialog=False))\n",
-    "area.addDock(logDock, 'bottom', xyselDock)\n",
+    "# # log\n",
+    "# logDock = Dock('Log', size=(250, 100))\n",
+    "# logDock.addWidget(plottrlog.setupLogging(makeDialog=False))\n",
+    "# area.addDock(logDock, 'bottom', xyselDock)\n",
     "\n",
     "# plot widget\n",
     "plotWidget = AutoPlot()\n",
@@ -396,8 +396,8 @@
     "win.show()\n",
     "\n",
     "### Logging\n",
-    "logger = plottrlog.getLogger()\n",
-    "plottrlog.LEVEL = logging.DEBUG"
+    "# logger = plottrlog.getLogger()\n",
+    "# plottrlog.LEVEL = logging.DEBUG"
    ]
   },
   {
@@ -414,8 +414,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:49:34.372580Z",
-     "start_time": "2019-01-01T20:49:34.105296Z"
+     "end_time": "2019-01-19T22:03:05.269586Z",
+     "start_time": "2019-01-19T22:03:05.015266Z"
     }
    },
    "outputs": [],
@@ -439,8 +439,8 @@
    "execution_count": null,
    "metadata": {
     "ExecuteTime": {
-     "end_time": "2019-01-01T20:49:51.460044Z",
-     "start_time": "2019-01-01T20:49:50.173445Z"
+     "end_time": "2019-01-19T22:03:49.026697Z",
+     "start_time": "2019-01-19T22:03:47.630430Z"
     }
    },
    "outputs": [],