Merge pull request #3536 from jenshnielsen/add_plot_to_dataset_api

Create public api for dataset.
microsoft · Jun 13, 2022 · bcfc19f · bcfc19f
2 parents 4c13452 + 33c8143
commit bcfc19f
Show file tree

Hide file tree

Showing 25 changed files with 1,756 additions and 1,670 deletions.
diff --git a/docs/api/dataset/data_set.rst b/docs/api/dataset/data_set.rst
diff --git a/docs/api/dataset/database_extract_runs.rst b/docs/api/dataset/database_extract_runs.rst
diff --git a/docs/api/dataset/index.rst b/docs/api/dataset/index.rst
@@ -4,25 +4,5 @@ qcodes.dataset
 ==============
 
 
-.. autosummary::
-
-    qcodes.dataset
-    qcodes.dataset.measurements
-    qcodes.dataset.plotting
-    qcodes.dataset.data_set
-    qcodes.dataset.database_extract_runs
-    qcodes.dataset.legacy_import
-
-
 .. automodule:: qcodes.dataset
-
-
-.. toctree::
-   :maxdepth: 4
-   :hidden:
-
-   measurements
-   plotting
-   data_set
-   database_extract_runs
-   legacy_import
+    :autosummary:
diff --git a/docs/api/dataset/legacy_import.rst b/docs/api/dataset/legacy_import.rst
diff --git a/docs/api/dataset/measurements.rst b/docs/api/dataset/measurements.rst
diff --git a/docs/api/dataset/plotting.rst b/docs/api/dataset/plotting.rst
diff --git a/docs/api/extensions/index.rst b/docs/api/extensions/index.rst
@@ -0,0 +1,7 @@
+.. _extensions_api :
+
+qcodes.extensions
+=================
+
+.. automodule:: qcodes.extensions
+    :autosummary:
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -18,6 +18,7 @@ QCoDeS API
 
    configuration/index
    dataset/index
+   extensions/index
    instrument/index
    parameters/index
    logger/index

diff --git a/docs/api/utils/index.rst b/docs/api/utils/index.rst
@@ -29,6 +29,5 @@ qcodes.utils
    magic
    metadata
    plotting
-   slack
    threading
    validators
diff --git a/docs/api/utils/slack.rst b/docs/api/utils/slack.rst
diff --git a/pyproject.toml b/pyproject.toml
@@ -55,7 +55,7 @@ module = [
     "qcodes.plots.*",
     "qcodes.tests.*",
     "qcodes.utils.magic",
-    "qcodes.utils.slack",
+    "qcodes.extensions.slack",
 
 ]
 disallow_untyped_defs = false

diff --git a/qcodes/dataset/__init__.py b/qcodes/dataset/__init__.py
@@ -11,7 +11,9 @@
 )
 from .data_set_in_memory import load_from_netcdf
 from .data_set_protocol import DataSetProtocol, DataSetType
+from .database_extract_runs import extract_runs_into_db
 from .descriptions.param_spec import ParamSpec
+from .do_nd import AbstractSweep, ArraySweep, LinSweep, LogSweep, do0d, do1d, do2d, dond
 from .experiment_container import (
     experiments,
     load_experiment,
@@ -20,7 +22,10 @@
     load_or_create_experiment,
     new_experiment,
 )
+from .experiment_settings import get_default_experiment_id, reset_default_experiment_id
+from .legacy_import import import_dat_file
 from .measurements import Measurement
+from .plotting import plot_by_id, plot_dataset
 from .sqlite.database import (
     initialise_database,
     initialise_or_create_database_at,
@@ -29,24 +34,38 @@
 from .sqlite.settings import SQLiteSettings
 
 __all__ = [
-    "load_by_counter",
-    "load_by_guid",
-    "load_by_id",
-    "load_by_run_spec",
-    "new_data_set",
-    "load_from_netcdf",
+    "AbstractSweep",
+    "ArraySweep",
     "DataSetProtocol",
     "DataSetType",
+    "LinSweep",
+    "LogSweep",
+    "Measurement",
     "ParamSpec",
+    "SQLiteSettings",
+    "do0d",
+    "do1d",
+    "do2d",
+    "dond",
     "experiments",
+    "extract_runs_into_db",
+    "get_default_experiment_id",
+    "import_dat_file",
+    "initialise_database",
+    "initialise_or_create_database_at",
+    "initialised_database_at",
+    "load_by_counter",
+    "load_by_guid",
+    "load_by_id",
+    "load_by_run_spec",
     "load_experiment",
     "load_experiment_by_name",
+    "load_from_netcdf",
     "load_last_experiment",
     "load_or_create_experiment",
+    "new_data_set",
     "new_experiment",
-    "Measurement",
-    "initialise_database",
-    "initialise_or_create_database_at",
-    "initialised_database_at",
-    "SQLiteSettings",
+    "plot_by_id",
+    "plot_dataset",
+    "reset_default_experiment_id",
 ]