qiskit-community · chriseclectic · Jul 21, 2021 · Jul 20, 2021 · Jul 20, 2021 · Jul 20, 2021
diff --git a/docs/apidocs/mod_calibration_management.rst → docs/apidocs/calibration_management.rst b/docs/apidocs/mod_calibration_management.rst → docs/apidocs/calibration_management.rst
diff --git a/docs/apidocs/curve_analysis.rst b/docs/apidocs/curve_analysis.rst
@@ -0,0 +1,6 @@
+.. _qiskit-experiments-curve-analysis:
+
+.. automodule:: qiskit_experiments.curve_analysis
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/docs/apidocs/mod_data_processing.rst → docs/apidocs/data_processing.rst b/docs/apidocs/mod_data_processing.rst → docs/apidocs/data_processing.rst
diff --git a/docs/apidocs/mod_database_service.rst → docs/apidocs/database_service.rst b/docs/apidocs/mod_database_service.rst → docs/apidocs/database_service.rst
diff --git a/docs/apidocs/framework.rst b/docs/apidocs/framework.rst
@@ -0,0 +1,6 @@
+.. _qiskit-experiments-framework:
+
+.. automodule:: qiskit_experiments.framework
+   :no-members:
+   :no-inherited-members:
+   :no-special-members:
diff --git a/docs/apidocs/index.rst b/docs/apidocs/index.rst
@@ -4,26 +4,22 @@
 Qiskit Experiments API Reference
 ================================
 
-.. toctree::
-    :maxdepth: 1
-
-    main
-    library
-
-Utility Modules
+Package Modules
 ===============
 
 .. toctree::
     :maxdepth: 1
 
-    mod_analysis
-    mod_calibration_management
-    mod_composite
-    mod_data_processing
-    mod_database_service
+    main
+    framework
+    library
+    data_processing
+    curve_analysis
+    calibration_management
+    database_service
 
-Experiments Modules
-===================
+Experiment Modules
+==================
 
 .. toctree::
     :maxdepth: 1

diff --git a/docs/apidocs/mod_analysis.rst b/docs/apidocs/mod_analysis.rst
diff --git a/docs/apidocs/mod_composite.rst b/docs/apidocs/mod_composite.rst
diff --git a/docs/tutorials/qst_example.ipynb b/docs/tutorials/qst_example.ipynb
@@ -13,7 +13,7 @@
    "source": [
     "from pprint import pprint\n",
     "import qiskit\n",
-    "from qiskit_experiments import ParallelExperiment\n",
+    "from qiskit_experiments.framework import ParallelExperiment\n",
     "from qiskit_experiments.library import StateTomography\n",
     "\n",
     "# For simulation\n",
@@ -405,15 +405,15 @@
  ],
  "metadata": {
   "interpreter": {
-   "hash": "42e50baa22dbe56fc7f4f6bf32ac20952839a6a23dcf2ef84eded7e8cac03444"
+   "hash": "c45f46a7fd077198472649b02925a2e599779de14e258f4f9ba8eb1d4e684fd2"
   },
   "kernelspec": {
-   "display_name": "Python 3.8.5 64-bit ('py38': conda)",
-   "name": "python3"
+   "name": "python3",
+   "display_name": "Python 3.7.7 64-bit ('qiskit-dev': conda)"
   },
   "language_info": {
    "name": "python",
-   "version": ""
+   "version": "3.7.7"
   }
  },
  "nbformat": 4,

diff --git a/docs/tutorials/qv_example.ipynb b/docs/tutorials/qv_example.ipynb
@@ -20,7 +20,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from qiskit_experiments import BatchExperiment\n",
+    "from qiskit_experiments.framework import BatchExperiment\n",
     "from qiskit_experiments.library import QuantumVolume\n",
     "from qiskit import Aer\n",
     "from qiskit.providers.aer import AerSimulator\n",

diff --git a/docs/tutorials/rb_example.ipynb b/docs/tutorials/rb_example.ipynb
diff --git a/docs/tutorials/t1.ipynb b/docs/tutorials/t1.ipynb
@@ -24,7 +24,7 @@
    "cell_type": "code",
    "execution_count": 1,
    "source": [
-    "from qiskit_experiments import ParallelExperiment\n",
+    "from qiskit_experiments.framework import ParallelExperiment\n",
     "from qiskit_experiments.library import T1\n",
     "\n",
     "# A T1 simulator\n",

diff --git a/qiskit_experiments/__init__.py b/qiskit_experiments/__init__.py
@@ -27,14 +27,22 @@
 Modules
 =======
 
-Experiment Library
-******************
-
-The :mod:`qiskit_experiments.library` module contains a list of available
-experiments.
-
-Experiment Utility Modules
---------------------------
+.. list-table::
+
+    * - :mod:`~qiskit_experiments.library`
+      - Library of available experiments.
+    * - :mod:`~qiskit_experiments.framework`
+      - Core classes for experiments and analysis.
+    * - :mod:`~qiskit_experiments.data_processing`
+      - Tools for building data processor workflows of experiment
+        measurement data.
+    * - :mod:`~qiskit_experiments.curve_analysis`
+      - Utility functions for curve fitting and analysis.
+    * - :mod:`~qiskit_experiments.calibration_management`
+      - Classes for managing calibration experiment result data.
+    * - :mod:`~qiskit_experiments.database_service`
+      - Classes for saving and retrieving experiment and analysis results
+        from a database.
 
 Certain experiments also have additional utilities contained which can be
 accessed by importing the following modules.
@@ -43,75 +51,14 @@
 - :mod:`qiskit_experiments.library.characterization`
 - :mod:`qiskit_experiments.library.randomized_benchmarking`
 - :mod:`qiskit_experiments.library.tomography`
-
-Analysis
-********
-
-This :mod:`qiskit_experiments.analysis` module contains utility functions for
-analysis experiment data.
-
-Data Processing
-***************
-
-This :mod:`qiskit_experiments.data_processing` module contains tools for processing
-experiment measurement data.
-
-Calibration Management
-**********************
-
-This :mod:`qiskit_experiments.calibration_management` module contains classes
-for managing calibration experiment result data.
-
-Database Service
-****************
-
-This :mod:`qiskit_experiments.database_service` module contains classes for saving
-and retrieving experiment and analysis results from a database.
-
-Experiment Data Classes
-=======================
-
-These container classes store the data and results from running experiments
-
-.. autosummary::
-    :toctree: ../stubs/
-
-    ExperimentData
-
-Composite Experiment Classes
-============================
-
-.. autosummary::
-    :toctree: ../stubs/
-
-    ~composite.BatchExperiment
-    ~composite.ParallelExperiment
-
-Experiment Base Classes
-=======================
-
-Construction of custom experiments should be done by making subclasses of the following
-base classes
-
-.. autosummary::
-    :toctree: ../stubs/
-
-    BaseExperiment
-    BaseAnalysis
 """
 
 from .version import __version__
 
-# Base Classes
-from .experiment_data import ExperimentData
-from .base_analysis import BaseAnalysis
-from .base_experiment import BaseExperiment
-from .composite import BatchExperiment, ParallelExperiment
-
 # Modules
+from . import framework
 from . import library
-from . import analysis
+from . import curve_analysis
 from . import calibration_management
-from . import composite
 from . import data_processing
 from . import database_service
diff --git a/qiskit_experiments/calibration_management/update_library.py b/qiskit_experiments/calibration_management/update_library.py
@@ -20,7 +20,7 @@
 from qiskit.circuit import Parameter
 from qiskit.pulse import ScheduleBlock
 
-from qiskit_experiments.experiment_data import ExperimentData
+from qiskit_experiments.framework.experiment_data import ExperimentData
 from qiskit_experiments.calibration_management.backend_calibrations import BackendCalibrations
 from qiskit_experiments.calibration_management.calibrations import Calibrations
 from qiskit_experiments.calibration_management.parameter_value import ParameterValue

diff --git a/qiskit_experiments/analysis/__init__.py → ...it_experiments/curve_analysis/__init__.py b/qiskit_experiments/analysis/__init__.py → ...it_experiments/curve_analysis/__init__.py
@@ -11,38 +11,36 @@
 # that they have been altered from the originals.
 
 """
-=====================================================
-Analysis Library (:mod:`qiskit_experiments.analysis`)
-=====================================================
+=========================================================
+Curve Analysis (:mod:`qiskit_experiments.curve_analysis`)
+=========================================================
 
-.. currentmodule:: qiskit_experiments.analysis
+.. currentmodule:: qiskit_experiments.curve_analysis
 
-Helper functions for experiment data analysis
-
-
-Curve Fitting
-=============
+Classes
+=======
 .. autosummary::
     :toctree: ../stubs/
 
-    curve_fit
-    multi_curve_fit
-    process_curve_data
-    process_multi_curve_data
+    CurveAnalysis
+    CurveAnalysisResultData
+    SeriesDef
+    CurveData
 
+Functions
+=========
+
+Curve Fitting
+*************
 
-Plotting
-========
 .. autosummary::
     :toctree: ../stubs/
 
-    plot_curve_fit
-    plot_errorbar
-    plot_scatter
-
+    curve_fit
+    multi_curve_fit
 
 Fit Functions
-=============
+*************
 .. autosummary::
     :toctree: ../stubs/
 
@@ -51,9 +49,8 @@
     fit_function.gaussian
     fit_function.sin
 
-
-Guess Functions
-===============
+Initial Guess
+*************
 .. autosummary::
     :toctree: ../stubs/
 
@@ -66,23 +63,33 @@
     guess.min_height
     guess.oscillation_exp_decay
 
+Visualization
+*************
+.. autosummary::
+    :toctree: ../stubs/
+
+    plot_curve_fit
+    plot_errorbar
+    plot_scatter
 
 Utility
-=======
+*******
 .. autosummary::
     :toctree: ../stubs/
 
     get_opt_error
     get_opt_value
 """
-from .curve_analysis import CurveAnalysis, SeriesDef, CurveData
-
-from .curve_fitting import (
-    CurveAnalysisResultData,
+from .curve_analysis import CurveAnalysis
+from .curve_analysis_result_data import CurveAnalysisResultData
+from .curve_data import CurveData, SeriesDef
+from .curve_fit import (
     curve_fit,
     multi_curve_fit,
     process_curve_data,
     process_multi_curve_data,
 )
-from .plotting import plot_curve_fit, plot_errorbar, plot_scatter
+from .visualization import plot_curve_fit, plot_errorbar, plot_scatter
 from .utils import get_opt_error, get_opt_value
+from . import guess
+from . import fit_function