diff --git a/docs/api/formats/index.md b/docs/api/formats/index.md deleted file mode 100644 index 0f181006..00000000 --- a/docs/api/formats/index.md +++ /dev/null @@ -1,12 +0,0 @@ -# formats - -```{eval-rst} -.. automodule:: miniscope_io.formats - :members: - :undoc-members: -``` - -```{toctree} -sdcard -stream -``` \ No newline at end of file diff --git a/docs/api/formats/sdcard.md b/docs/api/formats/sdcard.md deleted file mode 100644 index 60971b8a..00000000 --- a/docs/api/formats/sdcard.md +++ /dev/null @@ -1,7 +0,0 @@ -# sdcard - -```{eval-rst} -.. automodule:: miniscope_io.formats.sdcard - :members: - :undoc-members: -``` \ No newline at end of file diff --git a/docs/api/formats/stream.md b/docs/api/formats/stream.md deleted file mode 100644 index 9cca38d0..00000000 --- a/docs/api/formats/stream.md +++ /dev/null @@ -1,7 +0,0 @@ -# stream - -```{eval-rst} -.. automodule:: miniscope_io.formats.stream - :members: - :undoc-members: -``` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 6c83bc76..18a507c0 100644 --- a/docs/index.md +++ b/docs/index.md @@ -23,7 +23,6 @@ device/update_controller :caption: API: api/devices -api/formats/index api/io api/logging api/models/index diff --git a/miniscope_io/formats/__init__.py b/miniscope_io/formats/__init__.py deleted file mode 100644 index a1833181..00000000 --- a/miniscope_io/formats/__init__.py +++ /dev/null @@ -1,5 +0,0 @@ -""" -Instantiations of :class:`~.miniscope_io.models.MiniscopeConfig` models -that describe fixed per-device configurations for the generic config -models in :mod:`~.miniscope_io.models.stream` et al. -""" diff --git a/miniscope_io/formats/stream.py b/miniscope_io/formats/stream.py deleted file mode 100644 index 4786491e..00000000 --- a/miniscope_io/formats/stream.py +++ /dev/null @@ -1,20 +0,0 @@ -""" -Formats for use with :mod:`miniscope_io.stream_daq` -We plan to re-define this soon so documentation will come after that. -""" - -from miniscope_io.models.stream import StreamBufferHeaderFormat - -StreamBufferHeader = StreamBufferHeaderFormat( - linked_list=0, - frame_num=1, - buffer_count=2, - frame_buffer_count=3, - write_buffer_count=4, - dropped_buffer_count=5, - timestamp=6, - pixel_count=7, - write_timestamp=8, - battery_voltage_raw=9, - input_voltage_raw=10, -) diff --git a/tests/test_formats.py b/tests/test_formats.py deleted file mode 100644 index 671aa45a..00000000 --- a/tests/test_formats.py +++ /dev/null @@ -1,25 +0,0 @@ -import pytest -import json - -from miniscope_io.models.sdcard import SDLayout - - -# More formats can be added here as needed. -@pytest.mark.parametrize("format", [SDLayout.from_id("wirefree-sd-layout")]) -def test_to_from_json(format): - """ - A format can be exported and re-imported from JSON and remain equivalent - """ - fmt_json = format.model_dump_json() - - # convert the json to a dict - fmt_dict = json.loads(fmt_json) - - # Get the parent class - parent_class = type(format) - # parent_class_name = parent_module_str.split('.')[-1] - # parent_class = getattr(importlib.import_module(parent_module_str), parent_class_name) - - new_format = parent_class(**fmt_dict) - - assert format == new_format