BaPSF · rocco8773 · Apr 29, 2026 · Apr 29, 2026 · Apr 29, 2026 · Apr 29, 2026
diff --git a/bapsflib/_hdf/maps/controls/tests/__init__.py b/bapsflib/_hdf/maps/controls/tests/__init__.py
@@ -8,10 +8,3 @@
 # License: Standard 3-clause BSD; see "LICENSES/LICENSE.txt" for full
 #   license terms and contributor agreement.
 #
-from bapsflib._hdf.maps.controls.tests.fauxbmotion import FauxBMotion
-from bapsflib._hdf.maps.controls.tests.fauxn5700ps import FauxN5700PS
-from bapsflib._hdf.maps.controls.tests.fauxnixyz import FauxNIXYZ
-from bapsflib._hdf.maps.controls.tests.fauxnixz import FauxNIXZ
-from bapsflib._hdf.maps.controls.tests.fauxpositions180e import FauxPositions180E
-from bapsflib._hdf.maps.controls.tests.fauxsixk import FauxSixK
-from bapsflib._hdf.maps.controls.tests.fauxwaveform import FauxWaveform
diff --git a/bapsflib/_hdf/maps/controls/tests/test_bmotion.py b/bapsflib/_hdf/maps/controls/tests/test_bmotion.py
@@ -8,8 +8,8 @@
 
 from bapsflib._hdf.maps.controls.bmotion import HDFMapControlBMotion
 from bapsflib._hdf.maps.controls.tests.common import ControlTestCase
-from bapsflib._hdf.maps.controls.tests.fauxbmotion import FauxBMotion
 from bapsflib._hdf.maps.controls.types import ConType
+from bapsflib.faux.controls import FauxBMotion
 from bapsflib.utils import _bytes_to_str
 from bapsflib.utils.exceptions import HDFMappingError
 from bapsflib.utils.warnings import HDFMappingWarning

diff --git a/bapsflib/_hdf/maps/controls/tests/test_positions180e.py b/bapsflib/_hdf/maps/controls/tests/test_positions180e.py
@@ -3,10 +3,9 @@
 
 from bapsflib._hdf.maps.controls.positions180e import HDFMapControlPositions180E
 from bapsflib._hdf.maps.controls.tests.common import ControlTestCase
-from bapsflib._hdf.maps.controls.tests.fauxpositions180e import FauxPositions180E
 from bapsflib._hdf.maps.controls.types import ConType
+from bapsflib.faux.controls import FauxPositions180E
 from bapsflib.utils.exceptions import HDFMappingError
-from bapsflib.utils.warnings import HDFMappingWarning
 
 
 class TestPositions180E(ControlTestCase):

diff --git a/bapsflib/_hdf/maps/digitizers/tests/__init__.py b/bapsflib/_hdf/maps/digitizers/tests/__init__.py
@@ -1,3 +1 @@
-from bapsflib._hdf.maps.digitizers.tests.fauxlecroy180e import FauxLeCroy180E
-from bapsflib._hdf.maps.digitizers.tests.fauxsis3301 import FauxSIS3301
-from bapsflib._hdf.maps.digitizers.tests.fauxsiscrate import FauxSISCrate
+
diff --git a/bapsflib/_hdf/maps/digitizers/tests/test_lecroy.py b/bapsflib/_hdf/maps/digitizers/tests/test_lecroy.py
@@ -1,11 +1,10 @@
 import numpy as np
-import unittest as ut
 
 from unittest import mock
 
 from bapsflib._hdf.maps.digitizers.lecroy import HDFMapDigiLeCroy180E
 from bapsflib._hdf.maps.digitizers.tests.common import DigitizerTestCase
-from bapsflib._hdf.maps.digitizers.tests.fauxlecroy180e import FauxLeCroy180E
+from bapsflib.faux.digitizers import FauxLeCroy180E
 from bapsflib.utils.exceptions import HDFMappingError
 from bapsflib.utils.warnings import HDFMappingWarning
 

diff --git a/bapsflib/_hdf/maps/msi/tests/__init__.py b/bapsflib/_hdf/maps/msi/tests/__init__.py
@@ -1,15 +0,0 @@
-# This file is part of the bapsflib package, a Python toolkit for the
-# BaPSF group at UCLA.
-#
-# http://plasma.physics.ucla.edu/
-#
-# Copyright 2017-2018 Erik T. Everson and contributors
-#
-# License: Standard 3-clause BSD; see "LICENSES/LICENSE.txt" for full
-#   license terms and contributor agreement.
-#
-from bapsflib._hdf.maps.msi.tests.fauxdischarge import FauxDischarge
-from bapsflib._hdf.maps.msi.tests.fauxgaspressure import FauxGasPressure
-from bapsflib._hdf.maps.msi.tests.fauxheater import FauxHeater
-from bapsflib._hdf.maps.msi.tests.fauxinterarr import FauxInterferometerArray
-from bapsflib._hdf.maps.msi.tests.fauxmagneticfield import FauxMagneticField

diff --git a/bapsflib/_hdf/maps/tests/__init__.py b/bapsflib/_hdf/maps/tests/__init__.py
@@ -1,6 +1,6 @@
 __all__ = ["FauxHDFBuilder", "MapTestBase"]
 
-from bapsflib._hdf.maps.tests.fauxhdfbuilder import FauxHDFBuilder
+from bapsflib.faux import FauxHDFBuilder
 from bapsflib.utils.tests import BaPSFTestCase
 
 

diff --git a/bapsflib/_hdf/utils/tests/test_hdfreaddata.py b/bapsflib/_hdf/utils/tests/test_hdfreaddata.py
@@ -17,7 +17,6 @@
 import h5py
 import numpy as np
 import os
-import unittest as ut
 
 from typing import TYPE_CHECKING
 from unittest import mock
@@ -38,8 +37,7 @@
 
 if TYPE_CHECKING:
     # This is done for typing purposes only.  A full import is not needed.
-    from bapsflib._hdf.maps.digitizers.tests.fauxlecroy180e import FauxLeCroy180E
-    from bapsflib._hdf.maps.digitizers.tests.fauxsis3301 import FauxSIS3301
+    from bapsflib.faux.digitizers import FauxLeCroy180E, FauxSIS3301
 
 
 class TestHDFReadData(TestBase):

diff --git a/bapsflib/_hdf/utils/tests/test_helpers.py b/bapsflib/_hdf/utils/tests/test_helpers.py
@@ -18,7 +18,6 @@
 from numpy.lib import recfunctions as rfn
 
 from bapsflib._hdf.maps.controls.waveform import HDFMapControlWaveform
-from bapsflib._hdf.maps.digitizers.tests.fauxlecroy180e import FauxLeCroy180E
 from bapsflib._hdf.utils.file import File
 from bapsflib._hdf.utils.helpers import (
     build_shotnum_dset_relation,
@@ -27,6 +26,7 @@
     do_shotnum_intersection,
 )
 from bapsflib._hdf.utils.tests import TestBase
+from bapsflib.faux.digitizers import FauxLeCroy180E
 from bapsflib.utils import _bytes_to_str
 from bapsflib.utils.decorators import with_bf
 

diff --git a/bapsflib/faux/__init__.py b/bapsflib/faux/__init__.py
@@ -0,0 +1,26 @@
+"""
+.. caution::
+    The faux functionality is developed to test the `bapsflib` package
+    and help in generating example documnetion.  It is **NOT** intended
+    for end user use.
+
+The `bapsflib.faux` module contains functionality to generate fake /
+faux BaPSF style HDF5 files.
+
+`bapsflib.faux` is not explicitly exposed to the `bapsflib` namespace,
+so it needs to be explicitly imported.  For example:
+
+>>> import bapsflib
+>>> bapsflib.faux
+AttributeError: module 'bapsflib' has no attribute 'faux'
+>>>
+>>> import bapsflib.faux
+>>> bapsflib.faux
+<module 'bapsflib.faux'>
+
+"""
+
+__all__ = ["FauxHDFBuilder"]
+
+from bapsflib.faux import controls, digitizers, msi
+from bapsflib.faux.builder import FauxHDFBuilder
diff --git a/bapsflib/_hdf/maps/tests/fauxhdfbuilder.py → bapsflib/faux/builder.py b/bapsflib/_hdf/maps/tests/fauxhdfbuilder.py → bapsflib/faux/builder.py
@@ -1,3 +1,9 @@
+"""
+Module that defines the `~bapsflib.faux.builder.FauxHDFBuilder` class.
+"""
+
+__all__ = ["FauxHDFBuilder"]
+
 import h5py
 import inspect
 import os
@@ -6,7 +12,7 @@
 
 from typing import Any, Dict
 
-from bapsflib._hdf.maps.controls.tests import (
+from bapsflib.faux.controls import (
     FauxBMotion,
     FauxN5700PS,
     FauxNIXYZ,
@@ -15,8 +21,8 @@
     FauxSixK,
     FauxWaveform,
 )
-from bapsflib._hdf.maps.digitizers.tests import FauxLeCroy180E, FauxSIS3301, FauxSISCrate
-from bapsflib._hdf.maps.msi.tests import (
+from bapsflib.faux.digitizers import FauxLeCroy180E, FauxSIS3301, FauxSISCrate
+from bapsflib.faux.msi import (
     FauxDischarge,
     FauxGasPressure,
     FauxHeater,

diff --git a/bapsflib/faux/controls/__init__.py b/bapsflib/faux/controls/__init__.py
@@ -0,0 +1,22 @@
+"""
+The `bapsflib.faux.controls` module contains all the control device
+group generators used by `~bapsflib.faux.builder.FauxHDFBuilder`.
+"""
+
+__all__ = [
+    "FauxBMotion",
+    "FauxN5700PS",
+    "FauxNIXYZ",
+    "FauxNIXZ",
+    "FauxPositions180E",
+    "FauxSixK",
+    "FauxWaveform",
+]
+
+from bapsflib.faux.controls.bmotion import FauxBMotion
+from bapsflib.faux.controls.n5700ps import FauxN5700PS
+from bapsflib.faux.controls.nixyz import FauxNIXYZ
+from bapsflib.faux.controls.nixz import FauxNIXZ
+from bapsflib.faux.controls.positions180e import FauxPositions180E
+from bapsflib.faux.controls.sixk import FauxSixK
+from bapsflib.faux.controls.waveform import FauxWaveform
diff --git a/...b/_hdf/maps/controls/tests/fauxbmotion.py → bapsflib/faux/controls/bmotion.py b/...b/_hdf/maps/controls/tests/fauxbmotion.py → bapsflib/faux/controls/bmotion.py
diff --git a/...b/_hdf/maps/controls/tests/fauxn5700ps.py → bapsflib/faux/controls/n5700ps.py b/...b/_hdf/maps/controls/tests/fauxn5700ps.py → bapsflib/faux/controls/n5700ps.py
diff --git a/...lib/_hdf/maps/controls/tests/fauxnixyz.py → bapsflib/faux/controls/nixyz.py b/...lib/_hdf/maps/controls/tests/fauxnixyz.py → bapsflib/faux/controls/nixyz.py
diff --git a/...flib/_hdf/maps/controls/tests/fauxnixz.py → bapsflib/faux/controls/nixz.py b/...flib/_hdf/maps/controls/tests/fauxnixz.py → bapsflib/faux/controls/nixz.py
diff --git a/.../maps/controls/tests/fauxpositions180e.py → bapsflib/faux/controls/positions180e.py b/.../maps/controls/tests/fauxpositions180e.py → bapsflib/faux/controls/positions180e.py
diff --git a/...flib/_hdf/maps/controls/tests/fauxsixk.py → bapsflib/faux/controls/sixk.py b/...flib/_hdf/maps/controls/tests/fauxsixk.py → bapsflib/faux/controls/sixk.py
diff --git a/.../_hdf/maps/controls/tests/fauxwaveform.py → bapsflib/faux/controls/waveform.py b/.../_hdf/maps/controls/tests/fauxwaveform.py → bapsflib/faux/controls/waveform.py
diff --git a/bapsflib/faux/digitizers/__init__.py b/bapsflib/faux/digitizers/__init__.py
@@ -0,0 +1,14 @@
+"""
+The `bapsflib.faux.digitizers` module contains all the digitzer device
+group generators used by `~bapsflib.faux.builder.FauxHDFBuilder`.
+"""
+
+__all__ = [
+    "FauxSIS3301",
+    "FauxSISCrate",
+    "FauxLeCroy180E",
+]
+
+from bapsflib.faux.digitizers.lecroy180e import FauxLeCroy180E
+from bapsflib.faux.digitizers.sis3301 import FauxSIS3301
+from bapsflib.faux.digitizers.siscrate import FauxSISCrate
diff --git a/...f/maps/digitizers/tests/fauxlecroy180e.py → bapsflib/faux/digitizers/lecroy180e.py b/...f/maps/digitizers/tests/fauxlecroy180e.py → bapsflib/faux/digitizers/lecroy180e.py
diff --git a/..._hdf/maps/digitizers/tests/fauxsis3301.py → bapsflib/faux/digitizers/sis3301.py b/..._hdf/maps/digitizers/tests/fauxsis3301.py → bapsflib/faux/digitizers/sis3301.py
diff --git a/...hdf/maps/digitizers/tests/fauxsiscrate.py → bapsflib/faux/digitizers/siscrate.py b/...hdf/maps/digitizers/tests/fauxsiscrate.py → bapsflib/faux/digitizers/siscrate.py
diff --git a/bapsflib/faux/msi/__init__.py b/bapsflib/faux/msi/__init__.py
@@ -0,0 +1,18 @@
+"""
+The `bapsflib.faux.msi` module contains all the MSI device
+group generators used by `~bapsflib.faux.builder.FauxHDFBuilder`.
+"""
+
+__all__ = [
+    "FauxDischarge",
+    "FauxGasPressure",
+    "FauxHeater",
+    "FauxInterferometerArray",
+    "FauxMagneticField",
+]
+
+from bapsflib.faux.msi.discharge import FauxDischarge
+from bapsflib.faux.msi.gaspressure import FauxGasPressure
+from bapsflib.faux.msi.heater import FauxHeater
+from bapsflib.faux.msi.interarr import FauxInterferometerArray
+from bapsflib.faux.msi.magneticfield import FauxMagneticField
diff --git a/...flib/_hdf/maps/msi/tests/fauxdischarge.py → bapsflib/faux/msi/discharge.py b/...flib/_hdf/maps/msi/tests/fauxdischarge.py → bapsflib/faux/msi/discharge.py
diff --git a/...ib/_hdf/maps/msi/tests/fauxgaspressure.py → bapsflib/faux/msi/gaspressure.py b/...ib/_hdf/maps/msi/tests/fauxgaspressure.py → bapsflib/faux/msi/gaspressure.py
diff --git a/bapsflib/_hdf/maps/msi/tests/fauxheater.py → bapsflib/faux/msi/heater.py b/bapsflib/_hdf/maps/msi/tests/fauxheater.py → bapsflib/faux/msi/heater.py
diff --git a/bapsflib/_hdf/maps/msi/tests/fauxinterarr.py → bapsflib/faux/msi/interarr.py b/bapsflib/_hdf/maps/msi/tests/fauxinterarr.py → bapsflib/faux/msi/interarr.py
diff --git a/.../_hdf/maps/msi/tests/fauxmagneticfield.py → bapsflib/faux/msi/magneticfield.py b/.../_hdf/maps/msi/tests/fauxmagneticfield.py → bapsflib/faux/msi/magneticfield.py
diff --git a/docs/api_static/bapsflib.faux.builder.rst b/docs/api_static/bapsflib.faux.builder.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.builder
+=======================
+
+.. py:currentmodule:: bapsflib.faux.builder
+
+.. automodapi:: bapsflib.faux.builder
diff --git a/docs/api_static/bapsflib.faux.controls.bmotion.rst b/docs/api_static/bapsflib.faux.controls.bmotion.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.controls\.bmotion
+=================================
+
+.. py:currentmodule:: bapsflib.faux.controls.bmotion
+
+.. automodapi:: bapsflib.faux.controls.bmotion
diff --git a/docs/api_static/bapsflib.faux.controls.n5700ps.rst b/docs/api_static/bapsflib.faux.controls.n5700ps.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.controls\.n5700ps
+=================================
+
+.. py:currentmodule:: bapsflib.faux.controls.n5700ps
+
+.. automodapi:: bapsflib.faux.controls.n5700ps
diff --git a/docs/api_static/bapsflib.faux.controls.nixyz.rst b/docs/api_static/bapsflib.faux.controls.nixyz.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.controls\.nixyz
+===============================
+
+.. py:currentmodule:: bapsflib.faux.controls.nixyz
+
+.. automodapi:: bapsflib.faux.controls.nixyz
diff --git a/docs/api_static/bapsflib.faux.controls.nixz.rst b/docs/api_static/bapsflib.faux.controls.nixz.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.controls\.nixz
+==============================
+
+.. py:currentmodule:: bapsflib.faux.controls.nixz
+
+.. automodapi:: bapsflib.faux.controls.nixz
diff --git a/docs/api_static/bapsflib.faux.controls.positions180e.rst b/docs/api_static/bapsflib.faux.controls.positions180e.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.controls\.positions180e
+=======================================
+
+.. py:currentmodule:: bapsflib.faux.controls.positions180e
+
+.. automodapi:: bapsflib.faux.controls.positions180e
diff --git a/docs/api_static/bapsflib.faux.controls.rst b/docs/api_static/bapsflib.faux.controls.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.controls
+========================
+
+.. py:currentmodule:: bapsflib.faux.controls
+
+.. automodapi:: bapsflib.faux.controls
diff --git a/docs/api_static/bapsflib.faux.controls.sixk.rst b/docs/api_static/bapsflib.faux.controls.sixk.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.controls\.sixk
+==============================
+
+.. py:currentmodule:: bapsflib.faux.controls.sixk
+
+.. automodapi:: bapsflib.faux.controls.sixk
diff --git a/docs/api_static/bapsflib.faux.controls.waveform.rst b/docs/api_static/bapsflib.faux.controls.waveform.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.controls\.waveform
+==================================
+
+.. py:currentmodule:: bapsflib.faux.controls.waveform
+
+.. automodapi:: bapsflib.faux.controls.waveform
diff --git a/docs/api_static/bapsflib.faux.digitizers.lecroy180e.rst b/docs/api_static/bapsflib.faux.digitizers.lecroy180e.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.digitizers\.lecroy180e
+======================================
+
+.. py:currentmodule:: bapsflib.faux.digitizers.lecroy180e
+
+.. automodapi:: bapsflib.faux.digitizers.lecroy180e
diff --git a/docs/api_static/bapsflib.faux.digitizers.rst b/docs/api_static/bapsflib.faux.digitizers.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.digitizers
+==========================
+
+.. py:currentmodule:: bapsflib.faux.digitizers
+
+.. automodapi:: bapsflib.faux.digitizers
diff --git a/docs/api_static/bapsflib.faux.digitizers.sis3301.rst b/docs/api_static/bapsflib.faux.digitizers.sis3301.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.digitizers\.sis3301
+===================================
+
+.. py:currentmodule:: bapsflib.faux.digitizers.sis3301
+
+.. automodapi:: bapsflib.faux.digitizers.sis3301
diff --git a/docs/api_static/bapsflib.faux.digitizers.siscrate.rst b/docs/api_static/bapsflib.faux.digitizers.siscrate.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.digitizers\.siscrate
+====================================
+
+.. py:currentmodule:: bapsflib.faux.digitizers.siscrate
+
+.. automodapi:: bapsflib.faux.digitizers.siscrate
diff --git a/docs/api_static/bapsflib.faux.msi.discharge.rst b/docs/api_static/bapsflib.faux.msi.discharge.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.msi\.discharge
+==============================
+
+.. py:currentmodule:: bapsflib.faux.msi.discharge
+
+.. automodapi:: bapsflib.faux.msi.discharge
diff --git a/docs/api_static/bapsflib.faux.msi.gaspressure.rst b/docs/api_static/bapsflib.faux.msi.gaspressure.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.msi\.gaspressure
+================================
+
+.. py:currentmodule:: bapsflib.faux.msi.gaspressure
+
+.. automodapi:: bapsflib.faux.msi.gaspressure
diff --git a/docs/api_static/bapsflib.faux.msi.heater.rst b/docs/api_static/bapsflib.faux.msi.heater.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.msi\.heater
+===========================
+
+.. py:currentmodule:: bapsflib.faux.msi.heater
+
+.. automodapi:: bapsflib.faux.msi.heater
diff --git a/docs/api_static/bapsflib.faux.msi.interarr.rst b/docs/api_static/bapsflib.faux.msi.interarr.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.msi\.interarr
+=============================
+
+.. py:currentmodule:: bapsflib.faux.msi.interarr
+
+.. automodapi:: bapsflib.faux.msi.interarr
diff --git a/docs/api_static/bapsflib.faux.msi.magneticfield.rst b/docs/api_static/bapsflib.faux.msi.magneticfield.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.msi\.magneticfield
+==================================
+
+.. py:currentmodule:: bapsflib.faux.msi.magneticfield
+
+.. automodapi:: bapsflib.faux.msi.magneticfield
diff --git a/docs/api_static/bapsflib.faux.msi.rst b/docs/api_static/bapsflib.faux.msi.rst
@@ -0,0 +1,8 @@
+:orphan:
+
+bapsflib\.faux\.msi
+===================
+
+.. py:currentmodule:: bapsflib.faux.msi
+
+.. automodapi:: bapsflib.faux.msi