apsbits 1.0.0__py3-none-any.whl

apsbits-1.0.0.dist-info/METADATA

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: apsbits
+Version: 1.0.0
+Summary: Model of a Bluesky Data Acquisition Instrument in console, notebook, & queueserver.
+Author-email: Eric Codrea <ecodrea@anl.gov>, Pete Jemian <prjemian+instrument@gmail.com>, Rafael Vescovi <rvescovi@anl.gov>
+Maintainer-email: Eric Codrea <ecodrea@anl.gov>, Pete Jemian <prjemian+instrument@gmail.com>, Rafael Vescovi <rvescovi@anl.gov>
+License: Copyright (c) 2023-2025, UChicago Argonne, LLC
+        
+        All Rights Reserved
+        
+        BITS
+        
+        BCDA, Advanced Photon Source, Argonne National Laboratory
+        
+        
+        OPEN SOURCE LICENSE
+        
+        Redistribution and use in source and binary forms, with or without
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice,
+           this list of conditions and the following disclaimer.  Software changes,
+           modifications, or derivative works, should be noted with comments and
+           the author and organization's name.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice,
+           this list of conditions and the following disclaimer in the documentation
+           and/or other materials provided with the distribution.
+        
+        3. Neither the names of UChicago Argonne, LLC or the Department of Energy
+           nor the names of its contributors may be used to endorse or promote
+           products derived from this software without specific prior written
+           permission.
+        
+        4. The software and the end-user documentation included with the
+           redistribution, if any, must include the following acknowledgment:
+        
+           "This product includes software produced by UChicago Argonne, LLC
+           under Contract No. DE-AC02-06CH11357 with the Department of Energy."
+        
+        ****************************************************************************
+        
+        DISCLAIMER
+        
+        THE SOFTWARE IS SUPPLIED "AS IS" WITHOUT WARRANTY OF ANY KIND.
+        
+        Neither the United States GOVERNMENT, nor the United States Department
+        of Energy, NOR uchicago argonne, LLC, nor any of their employees, makes
+        any warranty, express or implied, or assumes any legal liability or
+        responsibility for the accuracy, completeness, or usefulness of any
+        information, data, apparatus, product, or process disclosed, or
+        represents that its use would not infringe privately owned rights.
+        
+        ****************************************************************************
+        
+Project-URL: Homepage, https://BCDA-APS.github.io/BITS/
+Project-URL: Bug Tracker, https://github.com/BCDA-APS/BITS/issues
+Keywords: bluesky,queueserver
+Classifier: Development Status :: 6 - Mature
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: License :: CC0 1.0 Universal (CC0 1.0) Public Domain Dedication
+Classifier: License :: Freely Distributable
+Classifier: License :: Public Domain
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: apstools>=1.7.2
+Requires-Dist: bluesky-queueserver-api
+Requires-Dist: bluesky-queueserver
+Requires-Dist: bluesky-widgets
+Requires-Dist: bluesky
+Requires-Dist: caproto
+Requires-Dist: databroker==1.2.5
+Requires-Dist: guarneri
+Requires-Dist: ipython
+Requires-Dist: jupyterlab
+Requires-Dist: ophyd-registry
+Requires-Dist: ophyd
+Requires-Dist: PyQt5>5.15
+Requires-Dist: pyRestTable
+Requires-Dist: pysumreg
+Requires-Dist: qtpy
+Requires-Dist: toml
+Requires-Dist: tomli
+Requires-Dist: tomli-w
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Provides-Extra: doc
+Requires-Dist: babel; extra == "doc"
+Requires-Dist: ipykernel; extra == "doc"
+Requires-Dist: jinja2; extra == "doc"
+Requires-Dist: markupsafe; extra == "doc"
+Requires-Dist: myst_parser; extra == "doc"
+Requires-Dist: nbsphinx; extra == "doc"
+Requires-Dist: pydata-sphinx-theme; extra == "doc"
+Requires-Dist: pygments-ipython-console; extra == "doc"
+Requires-Dist: pygments; extra == "doc"
+Requires-Dist: sphinx-design; extra == "doc"
+Requires-Dist: sphinx-tabs; extra == "doc"
+Requires-Dist: sphinx; extra == "doc"
+Provides-Extra: all
+Requires-Dist: apsbits[dev,doc]; extra == "all"
+Dynamic: license-file
+
+# APSBITS: Template Package for Bluesky Instruments
+
+| PyPI | Coverage |
+| --- | --- |
+[![PyPi](https://img.shields.io/pypi/v/apsbits.svg)](https://pypi.python.org/pypi/apsbits) | [![Coverage Status](https://coveralls.io/repos/github/BCDA-APS/BITS/badge.svg?branch=main)](https://coveralls.io/github/BCDA-APS/BITS?branch=main) |
+
+BITS: **B**luesky **I**nstrument **T**emplate **S**tructure
+
+Template of a Bluesky Data Acquisition Instrument in console, notebook, &
+queueserver.
+
+## Production use of BITS
+
+Please create a bits instrument using our template repository: https://github.com/BCDA-APS/DEMO-BITS
+
+
+## Installing the BITS Package for Development
+
+```bash
+git clone github.com:BCDA-APS/BITS.git
+cd BITS
+conda create -y -n BITS_env python=3.11 pyepics
+conda activate BITS_env
+pip install -e ."[all]"
+```
+
+## Testing the apsbits base installation
+
+On an ipython console
+
+```py
+from apsbits.demo_instrument.startup import *
+listobjects()
+RE(sim_print_plan())
+RE(sim_count_plan())
+RE(sim_rel_scan_plan())
+```
+
+## Testing
+
+Use this command to run the test suite locally:
+
+```bash
+pytest -vvv --lf ./src
+```
+
+## Documentation
+
+<details>
+<summary>prerequisite</summary>
+
+To build the documentation locally, install [`pandoc`](https://pandoc.org/) in
+your conda environment:
+
+```bash
+conda install conda-forge::pandoc
+```
+
+</details>
+
+Use this command to build the documentation locally:
+
+```bash
+make -C docs clean html
+```
+
+Once the documentation builds, view the HTML pages using your web browser:
+
+```bash
+BROWSER ./docs/build/html/index.html &
+```
+
+### Adding to the documentation source
+
+The documentation source is located in files and directories under
+`./docs/source`.  Various examples are provided.
+
+Documentation can be added in these formats:
+[`.rst`](https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
+(reStructured text), [`.md`](https://en.wikipedia.org/wiki/Markdown) (markdown),
+and [`.ipynb`](https://jupyter.org/) (Jupyter notebook). For more information,
+see the [Sphinx](https://www.sphinx-doc.org/) documentation.

apsbits-1.0.0.dist-info/RECORD

@@ -0,0 +1,47 @@
+apsbits/__init__.py,sha256=aC6iFpu22_zSzmQDjkrd3FcthCgjoD1SUiZ-7j_TwuY,442
+apsbits/_version.py,sha256=fo5PXsZuloQZu3LdpIFTUAXvJmY2L9N5sNGe2tvdU98,511
+apsbits/core/__init__.py,sha256=CmmaJwx5aAUf2d-svOMw9paMlKnCSz_xvEPBAW8e5nA,266
+apsbits/core/best_effort_init.py,sha256=XiE0FPqixqKdAiqLwxfUlygVeUmGjoTqbFPxURKDc1E,1298
+apsbits/core/catalog_init.py,sha256=Bio154ee5GOZTOBnm3FyjS-cHnH_bocp6vOs8XAH1a8,755
+apsbits/core/run_engine_init.py,sha256=uzfmW8Wdxzn5hMslFGGmU4xdUD-jAzl93MADa__YZtQ,4373
+apsbits/demo_instrument/README.md,sha256=fLZWnARxJxOZSwrb1eIN4UtRpxrLgKeApU5xJ5jGNWs,19
+apsbits/demo_instrument/__init__.py,sha256=jmvy-yVcbli9z0tmkOTywEjgyT28g0TxKaUh2K0wGTY,530
+apsbits/demo_instrument/startup.py,sha256=wKjcBvLNDtj4tW5dKWuRKX0N_Z-VhT94YPb8sve_J40,2436
+apsbits/demo_instrument/callbacks/__init__.py,sha256=UlYegbF9GbziD1UzgscoGo9T5aFPvs-upwXxPQmBEjY,35
+apsbits/demo_instrument/callbacks/nexus_data_file_writer.py,sha256=XJy_kuMjxNIG0lxRq7lFuYnchP36vZFqi3hnDjjrc1k,1624
+apsbits/demo_instrument/callbacks/spec_data_file_writer.py,sha256=oUckr7mIIWUGLzJHPGftaTZJyV8uNDkrcGJPpFJLQSE,2803
+apsbits/demo_instrument/configs/__init__.py,sha256=mhZO8bz7uexqBJx0PrILGQM6ssHPbCx8fld7EtRy6so,46
+apsbits/demo_instrument/configs/devices.yml,sha256=sbAyUSqCF2CeCp_KKmCBEuOj3gT1h8OP_eR5uqROby0,1305
+apsbits/demo_instrument/configs/devices_aps_only.yml,sha256=XR9ZB-RaVpG-rghDSYKL8A16wETuOi7mzlx7U8LBCTg,136
+apsbits/demo_instrument/configs/iconfig.yml,sha256=bUfhcio-mXxP3S6Fw2Xc71o2GAiCEcVvyPoCgYlzSP8,2246
+apsbits/demo_instrument/configs/logging.yml,sha256=ydODRE8cUqzZvI7xxTB9jT6hEQci8jKrshF8mwRV9fo,836
+apsbits/demo_instrument/devices/__init__.py,sha256=3nhJy2BDR_nelXjxWw5_1Ppg7zStO6v2vJNpvO06IYU,27
+apsbits/demo_instrument/plans/__init__.py,sha256=Qjo7AYRIReo-x5i9rkpiYs86F5C8adDchn_Ghe-Qn1A,356
+apsbits/demo_instrument/plans/dm_plans.py,sha256=SeZMKQeQGlQ-abpv3Ccfe9BgQDHMxFQq0pEgsiZCeb4,3445
+apsbits/demo_instrument/plans/sim_plans.py,sha256=er9Dekkh9ob6t-GBR0tb2EIBdgr3JqRdIfr2xTi_l-Y,1963
+apsbits/demo_qserver/qs-config.yml,sha256=Lf-o0-Ldwh90OcAY7xEgyD4ndLs-RM40QXqZmRDoOmY,1244
+apsbits/demo_qserver/qs_host.sh,sha256=OBISAZb-DMMXN0rGt9Ea-lRVvVgqvzdrQFKlZz8K8Ao,6974
+apsbits/demo_qserver/user_group_permissions.yaml,sha256=qNVoInWpvtLujYK_oOD7wD9o319yGSZiqGp_J_iUQ6Q,1621
+apsbits/tests/__init__.py,sha256=ZqbT_R0daJUQAawNOy472d-DOwwYxmZQKuZp3jivZDM,48
+apsbits/tests/conftest.py,sha256=K7mLdZoiFKVpihA_eiWhNBS5YHnEuffFHOn3Y-1_aZE,1155
+apsbits/tests/test_config.py,sha256=Qum4h8Vi-YOj2I4Um8hw1ZNVsytwgYUG9p6nzms8OVI,3077
+apsbits/tests/test_device_factories.py,sha256=Uoq3V6zugCLCqNagln81N3d7dk_e8bTAsH5ZwEKpVrI,1364
+apsbits/tests/test_general.py,sha256=lbyJXN_RjI-_jxVR0pcAHVKE5pWNvS_IC64g_S5lGuw,2996
+apsbits/tests/test_stored_dict.py,sha256=BmJAXnQFtkqdXloiMdzUXDxZ1SH-wwNyQmgmWOyhQkI,4248
+apsbits/utils/__init__.py,sha256=2ZlHuOIAtb-kEBwQoabNVWD5QOVtDBORgdy1BzI8NS8,45
+apsbits/utils/aps_functions.py,sha256=o4ZQ0GCdftpCRJnVcjKrx5WnQNV0gwnA_oXS8rBhGN0,2135
+apsbits/utils/config_loaders.py,sha256=JGoWROkGx7sly8oRa7Um4Gg5SuC9eiIM4jhn8wdQgH0,4676
+apsbits/utils/controls_setup.py,sha256=eXWyAOsu9CA7vR7DL_ibfFeuOGtxphnXu_JEA-lm8tw,3158
+apsbits/utils/create_new_instrument.py,sha256=q_vqkmhZXSyhjparr6nEcwWiPF4zCdItzpsLOB3AlJw,3670
+apsbits/utils/helper_functions.py,sha256=NLoTjmyXNfAKXiggmcR_IYZUso2iAFxl-7eVKaPQB4o,3409
+apsbits/utils/logging_setup.py,sha256=dQEHnODseKFC7s86TmIqTY27_Ea36g5w_lH6jbDBXOo,7047
+apsbits/utils/make_devices.py,sha256=Hp90wdrhg8x8vH1_zir_prUb10_oLfW9fhMG3x6ppRs,5065
+apsbits/utils/metadata.py,sha256=8BrcYaryjwYrFZnfs7DW6GdCMCe52aJh0ULiP3epsdQ,2531
+apsbits/utils/sim_creator.py,sha256=tTgD0FDqL5_QgYlBZ9_KmCVMqM7uz94yT2E7yycF3KY,5358
+apsbits/utils/stored_dict.py,sha256=dRY51g1Of9oa0Nvldy334o1eDYUAEdCYxx6MarCUmy4,5512
+apsbits-1.0.0.dist-info/licenses/LICENSE,sha256=VRL4rXRDmRe62o4ci_VPKWl_z8_96c-U6DUqelNBgI0,1927
+apsbits-1.0.0.dist-info/METADATA,sha256=Iib2Qqo6LLgXJl5ahKWZ2EDAQb4Xl7anOjqza6C5z3s,6789
+apsbits-1.0.0.dist-info/WHEEL,sha256=1tXe9gY0PYatrMPMDd6jXqjfpz_B-Wqm32CPfRC58XU,91
+apsbits-1.0.0.dist-info/entry_points.txt,sha256=iLl4F8OZNqN7wb-wmKSBY8_LDK7B2CnGWbPMNIt8QEA,73
+apsbits-1.0.0.dist-info/top_level.txt,sha256=K0KyAyPka1k4prJJFWALbX0gcUL3i4kiflTvSeM_6O4,8
+apsbits-1.0.0.dist-info/RECORD,,

apsbits-1.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (77.0.3)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

apsbits-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+create-bits = apsbits.utils.create_new_instrument:main

apsbits-1.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,48 @@
+Copyright (c) 2023-2025, UChicago Argonne, LLC
+
+All Rights Reserved
+
+BITS
+
+BCDA, Advanced Photon Source, Argonne National Laboratory
+
+
+OPEN SOURCE LICENSE
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.  Software changes,
+   modifications, or derivative works, should be noted with comments and
+   the author and organization's name.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the names of UChicago Argonne, LLC or the Department of Energy
+   nor the names of its contributors may be used to endorse or promote
+   products derived from this software without specific prior written
+   permission.
+
+4. The software and the end-user documentation included with the
+   redistribution, if any, must include the following acknowledgment:
+
+   "This product includes software produced by UChicago Argonne, LLC
+   under Contract No. DE-AC02-06CH11357 with the Department of Energy."
+
+****************************************************************************
+
+DISCLAIMER
+
+THE SOFTWARE IS SUPPLIED "AS IS" WITHOUT WARRANTY OF ANY KIND.
+
+Neither the United States GOVERNMENT, nor the United States Department
+of Energy, NOR uchicago argonne, LLC, nor any of their employees, makes
+any warranty, express or implied, or assumes any legal liability or
+responsibility for the accuracy, completeness, or usefulness of any
+information, data, apparatus, product, or process disclosed, or
+represents that its use would not infringe privately owned rights.
+
+****************************************************************************

apsbits-1.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+apsbits