add README

.github/workflows/code.yml

@@ -136,7 +136,7 @@ jobs:
         shell: bash -l {0}
         run: |
           set -vxeuo pipefail
-          ipython -c "from instrument.startup import *; RE(make_devices())"
+          ipython -c "from bits.demo_instrument.startup import *; RE(make_devices())"
 
   # https://coveralls-python.readthedocs.io/en/latest/usage/configuration.html#github-actions-support
   coveralls:

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 copyright = "2014-2025, APS"
 
 [project]
-name = "instrument"
+name = "bits"
 dynamic = ["version"]
 description = "Model of a Bluesky Data Acquisition Instrument in console, notebook, & queueserver."
 authors = [
@@ -71,14 +71,12 @@ doc = [
     "sphinx",
 ]
 
-all = ["instrument[dev,doc]"]
+all = ["bits[dev,doc]"]
 
 [project.urls]
 "Homepage" = "https://BCDA-APS.github.io/BITS/"
 "Bug Tracker" = "https://github.com/BCDA-APS/BITS/issues"
 
-# [project.scripts]
-# instrument = "instrument.app:main"
 
 [tool.black]
 line-length = 115

src/bits/__init__.py

@@ -6,7 +6,7 @@
 
 configure_logging()
 
-__package__ = "instrument"
+__package__ = "bits"
 try:
     from setuptools_scm import get_version
 

src/bits/demo_instrument/README.md

@@ -0,0 +1 @@
+## Demo Instrument

src/bits/demo_instrument/configs/iconfig.yml

@@ -11,7 +11,7 @@ DATABROKER_CATALOG: &databroker_catalog temp
 ### RunEngine configuration
 RUN_ENGINE:
     DEFAULT_METADATA:
-        beamline_id: instrument
+        beamline_id: demo_instrument
         instrument_name: Most Glorious Scientific Instrument
         proposal_id: commissioning
         databroker_catalog: *databroker_catalog

src/bits/demo_instrument/startup.py

@@ -34,12 +34,12 @@
 
 # Configure the session with callbacks, devices, and plans.
 if iconfig.get("NEXUS_DATA_FILES", {}).get("IS_ON", False):
-    from ..callbacks.nexus_data_file_writer import nxwriter  # noqa: F401
+    from bits.callbacks.nexus_data_file_writer import nxwriter  # noqa: F401
 
 if iconfig.get("SPEC_DATA_FILES", {}).get("IS_ON", False):
-    from ..callbacks.spec_data_file_writer import newSpecFile  # noqa: F401
-    from ..callbacks.spec_data_file_writer import spec_comment  # noqa: F401
-    from ..callbacks.spec_data_file_writer import specwriter  # noqa: F401
+    from bits.callbacks.spec_data_file_writer import newSpecFile  # noqa: F401
+    from bits.callbacks.spec_data_file_writer import spec_comment  # noqa: F401
+    from bits.callbacks.spec_data_file_writer import specwriter  # noqa: F401
 
 # These imports must come after the above setup.
 if running_in_queueserver():
@@ -56,4 +56,4 @@
     from bluesky import plan_stubs as bps  # noqa: F401
     from bluesky import plans as bp  # noqa: F401
 
-    from ..utils.controls_setup import oregistry  # noqa: F401
+    from bits.utils.controls_setup import oregistry  # noqa: F401