Merge pull request #11 from Sun-Lab-NBB/4.0.0

Deprecated NestedDictionary, Refactored the API for DataLogger and SharedMemoryArray.

Author: Inkaros

README.md

@@ -1,30 +1,23 @@
 .. This file provides the instructions for how to display the API documentation generated using sphinx autodoc
    extension. Use it to declare Python documentation sub-directories via appropriate modules (autodoc, etc.).
 
-Shared Memory Array
-===================
-.. automodule:: ataraxis_data_structures.shared_memory.shared_memory_array
+Shared Memory
+=============
+.. automodule:: ataraxis_data_structures.shared_memory
    :members:
    :undoc-members:
    :show-inheritance:
 
-Nested Dictionary
-=================
-.. automodule:: ataraxis_data_structures.data_structures.nested_dictionary
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Yaml Config
-===========
-.. automodule:: ataraxis_data_structures.data_structures.yaml_config
+Data Structures
+===============
+.. automodule:: ataraxis_data_structures.data_structures
    :members:
    :undoc-members:
    :show-inheritance:
 
 Data Loggers
 ============
-.. automodule:: ataraxis_data_structures.data_loggers.serialized_data_logger
+.. automodule:: ataraxis_data_structures.data_loggers
    :members:
    :undoc-members:
    :show-inheritance:

docs/source/api.rst

@@ -4,8 +4,8 @@
 # -- Project information -----------------------------------------------------
 project = 'ataraxis-data-structures'
 # noinspection PyShadowingBuiltins
-copyright = '2024, Ivan Kondratyev (Inkaros) & Sun Lab'
-authors = ['Ivan Kondratyev (Inkaros)', 'Edwin Chen']
+copyright = '2025, Sun (NeuroAI) lab'
+author = 'Ivan Kondratyev'
 release = importlib_metadata.version("ataraxis-data-structures")  # Extracts the project version from the .toml file.
 
 # -- General configuration ---------------------------------------------------
@@ -24,8 +24,8 @@
 napoleon_google_docstring = True
 napoleon_numpy_docstring = False
 napoleon_include_init_with_doc = False
-napoleon_include_private_with_doc = True
-napoleon_include_special_with_doc = True
+napoleon_include_private_with_doc = False
+napoleon_include_special_with_doc = False
 napoleon_use_admonition_for_examples = False
 napoleon_use_admonition_for_notes = False
 napoleon_use_admonition_for_references = False
@@ -44,7 +44,7 @@
 typehints_use_signature = False
 typehints_use_signature_return = False
 
-# RTD dark mode starts in light mode
+# Disables the dark mode by default.
 default_dark_mode = False
 
 # -- Options for HTML output -------------------------------------------------

docs/source/conf.py

@@ -5,11 +5,11 @@ ataraxis-data-structures is a Python library that provides classes and structure
 sharing data between Python processes.
 
 This library is part of the broader 'Ataraxis' science-automation project, developed in the
-`Sun Lab <https://neuroai.github.io/sunlab/>`_ at Cornell University.
+`Sun (NeuroAI) lab <https://neuroai.github.io/sunlab/>`_ at Cornell University.
 
 This website only contains the API documentation for the classes and methods offered by this library. See the project
 GitHub repository for installation instructions and library usage examples:
 `ataraxis-data-structures GitHub repository <https://github.com/Sun-Lab-NBB/ataraxis-data-structures>`_.
 
 .. _`ataraxis-data-structures GitHub repository`: https://github.com/Sun-Lab-NBB/ataraxis-data-structures
-.. _`Sun Lab`: https://neuroai.github.io/sunlab/
+.. _`Sun (NeuroAI) lab`: https://neuroai.github.io/sunlab/

docs/source/welcome.rst

@@ -4,159 +4,41 @@ channels:
 dependencies:
   - _libgcc_mutex=0.1=conda_forge
   - _openmp_mutex=4.5=2_gnu
-  - alabaster=1.0.0=pyhd8ed1ab_1
-  - babel=2.16.0=pyhd8ed1ab_1
-  - backports=1.0=pyhd8ed1ab_5
-  - backports.tarfile=1.2.0=pyhd8ed1ab_1
-  - beautifulsoup4=4.12.3=pyha770c72_1
-  - brotli-python=1.1.0=py313h46c70d0_2
-  - bzip2=1.0.8=h4bc722e_7
-  - ca-certificates=2024.12.14=hbcca054_0
-  - cachetools=5.5.0=pyhd8ed1ab_1
-  - certifi=2024.12.14=pyhd8ed1ab_0
-  - cffi=1.17.1=py313hfab6e84_0
-  - chardet=5.2.0=py313h78bf25f_2
-  - charset-normalizer=3.4.1=pyhd8ed1ab_0
-  - cmarkgfm=2024.11.20=py313h536fd9c_0
+  - bzip2=1.0.8=hda65f42_8
+  - ca-certificates=2025.8.3=hbd8a1cb_0
+  - cachetools=6.2.0=pyhd8ed1ab_0
+  - chardet=5.2.0=pyhd8ed1ab_3
   - colorama=0.4.6=pyhd8ed1ab_1
-  - conda-souschef=2.2.3=pyhd8ed1ab_0
-  - coverage=7.6.10=py313h8060acc_0
-  - cryptography=44.0.0=py313h6556f6e_0
-  - dacite=1.8.1=pyhd8ed1ab_0
-  - dbus=1.13.6=h5008d03_3
-  - distlib=0.3.9=pyhd8ed1ab_1
-  - docutils=0.21.2=pyhd8ed1ab_1
-  - editables=0.5=pyhd8ed1ab_1
-  - exceptiongroup=1.2.2=pyhd8ed1ab_1
-  - execnet=2.1.1=pyhd8ed1ab_1
-  - expat=2.6.4=h5888daf_0
-  - filelock=3.16.1=pyhd8ed1ab_1
-  - future=1.0.0=pyhd8ed1ab_1
-  - grayskull=2.7.6=pyhd8ed1ab_0
-  - h2=4.1.0=pyhd8ed1ab_1
-  - hatchling=1.27.0=pypyhd8ed1ab_0
-  - hpack=4.0.0=pyhd8ed1ab_1
-  - hyperframe=6.0.1=pyhd8ed1ab_1
-  - idna=3.10=pyhd8ed1ab_1
-  - imagesize=1.4.1=pyhd8ed1ab_0
-  - importlib-metadata=8.5.0=pyha770c72_1
-  - importlib_metadata=8.5.0=hd8ed1ab_1
-  - importlib_resources=6.5.2=pyhd8ed1ab_0
-  - iniconfig=2.0.0=pyhd8ed1ab_1
-  - jaraco.classes=3.4.0=pyhd8ed1ab_2
-  - jaraco.context=6.0.1=pyhd8ed1ab_0
-  - jaraco.functools=4.1.0=pyhd8ed1ab_0
-  - jeepney=0.8.0=pyhd8ed1ab_0
-  - jinja2=3.1.5=pyhd8ed1ab_0
-  - junitparser=3.2.0=pyhd8ed1ab_1
-  - keyring=25.6.0=pyha804496_0
-  - ld_impl_linux-64=2.43=h712a8e2_2
-  - libblas=3.9.0=26_linux64_openblas
-  - libcblas=3.9.0=26_linux64_openblas
-  - libexpat=2.6.4=h5888daf_0
-  - libffi=3.4.2=h7f98852_5
-  - libgcc=14.2.0=h77fa898_1
-  - libgcc-ng=14.2.0=h69a702a_1
-  - libgfortran=14.2.0=h69a702a_1
-  - libgfortran5=14.2.0=hd5240d6_1
-  - libglib=2.82.2=h2ff4ddf_1
-  - libgomp=14.2.0=h77fa898_1
-  - libiconv=1.17=hd590300_2
-  - liblapack=3.9.0=26_linux64_openblas
-  - liblzma=5.6.3=hb9d3cd8_1
-  - libmpdec=4.0.0=h4bc722e_0
-  - libopenblas=0.3.28=pthreads_h94d23a6_1
-  - libsqlite=3.48.0=hee588c1_0
-  - libstdcxx=14.2.0=hc0a3c3a_1
-  - libstdcxx-ng=14.2.0=h4852527_1
-  - libuuid=2.38.1=h0b41bf4_0
+  - distlib=0.4.0=pyhd8ed1ab_0
+  - filelock=3.19.1=pyhd8ed1ab_0
+  - ld_impl_linux-64=2.44=ha97dd6f_2
+  - libexpat=2.7.1=hecca717_0
+  - libffi=3.4.6=h2dba641_1
+  - libgcc=15.1.0=h767d61c_5
+  - libgomp=15.1.0=h767d61c_5
+  - liblzma=5.8.1=hb9d3cd8_2
+  - libmpdec=4.0.0=hb9d3cd8_0
+  - libsqlite=3.50.4=h0c1763c_0
+  - libstdcxx=15.1.0=h8f9b012_5
+  - libuuid=2.41.2=he9a06e4_0
   - libzlib=1.3.1=hb9d3cd8_2
-  - markdown-it-py=3.0.0=pyhd8ed1ab_1
-  - markupsafe=3.0.2=py313h8060acc_1
-  - mdurl=0.1.2=pyhd8ed1ab_1
-  - more-itertools=10.6.0=pyhd8ed1ab_0
-  - mypy=1.14.1=py313h536fd9c_0
-  - mypy_extensions=1.0.0=pyha770c72_1
-  - ncurses=6.5=h2d0b736_2
-  - nh3=0.2.20=py313h920b4c0_0
-  - numpy=2.2.1=py313hb30382a_0
-  - openssl=3.4.0=h7b32b05_1
-  - packaging=24.2=pyhd8ed1ab_2
-  - pathspec=0.12.1=pyhd8ed1ab_1
-  - pcre2=10.44=hba22ea6_2
-  - pip=24.3.1=pyh145f28c_2
-  - pkginfo=1.12.0=pyhd8ed1ab_1
-  - platformdirs=4.3.6=pyhd8ed1ab_1
-  - pluggy=1.5.0=pyhd8ed1ab_1
-  - progressbar2=4.5.0=pyhd8ed1ab_1
-  - psutil=6.1.1=py313h536fd9c_0
-  - pycparser=2.22=pyh29332c3_1
-  - pygments=2.19.1=pyhd8ed1ab_0
-  - pyproject-api=1.8.0=pyhd8ed1ab_1
-  - pysocks=1.7.1=pyha55dd90_7
-  - pytest=8.3.4=pyhd8ed1ab_1
-  - pytest-cov=6.0.0=pyhd8ed1ab_1
-  - pytest-xdist=3.6.1=pyhd8ed1ab_1
-  - python=3.13.1=ha99a958_105_cp313
-  - python-utils=3.9.1=pyhff2d567_1
-  - python_abi=3.13=5_cp313
-  - pytz=2024.2=pyhd8ed1ab_1
-  - pyyaml=6.0.2=py313h536fd9c_1
-  - rapidfuzz=3.11.0=py313h46c70d0_0
-  - readline=8.2=h8228510_1
-  - readme_renderer=44.0=pyhd8ed1ab_1
-  - requests=2.32.3=pyhd8ed1ab_1
-  - requests-toolbelt=1.0.0=pyhd8ed1ab_1
-  - rfc3986=2.0.0=pyhd8ed1ab_1
-  - rich=13.9.4=pyhd8ed1ab_1
-  - ruamel.yaml=0.18.10=py313h536fd9c_0
-  - ruamel.yaml.clib=0.2.8=py313h536fd9c_1
-  - ruamel.yaml.jinja2=0.2.7=pyhd8ed1ab_1
-  - ruff=0.9.1=py313he87ea70_0
-  - secretstorage=3.3.3=py313h78bf25f_3
-  - setuptools=75.8.0=pyhff2d567_0
-  - snowballstemmer=2.2.0=pyhd8ed1ab_0
-  - soupsieve=2.5=pyhd8ed1ab_1
-  - sphinx=8.1.3=pyhd8ed1ab_1
-  - sphinx-autodoc-typehints=3.0.1=pyhd8ed1ab_0
-  - sphinx-rtd-theme=3.0.1=hd8ed1ab_0
-  - sphinx_rtd_theme=3.0.1=pyha770c72_0
-  - sphinxcontrib-applehelp=2.0.0=pyhd8ed1ab_1
-  - sphinxcontrib-devhelp=2.0.0=pyhd8ed1ab_1
-  - sphinxcontrib-htmlhelp=2.1.0=pyhd8ed1ab_1
-  - sphinxcontrib-jquery=4.1=pyhd8ed1ab_1
-  - sphinxcontrib-jsmath=1.0.1=pyhd8ed1ab_1
-  - sphinxcontrib-qthelp=2.0.0=pyhd8ed1ab_1
-  - sphinxcontrib-serializinghtml=1.1.10=pyhd8ed1ab_1
-  - stdlib-list=0.11.0=pyhd8ed1ab_1
-  - tk=8.6.13=noxft_h4845f30_101
-  - toml=0.10.2=pyhd8ed1ab_1
-  - tomli=2.2.1=pyhd8ed1ab_1
-  - tomli-w=1.2.0=pyhd8ed1ab_0
-  - tox=4.23.2=pyhd8ed1ab_1
-  - trove-classifiers=2025.1.15.22=pyhd8ed1ab_0
-  - twine=6.0.1=pyhd8ed1ab_1
-  - types-pyyaml=6.0.12.20241230=pyhd8ed1ab_0
-  - types-requests=2.32.0.20241016=pyhd8ed1ab_1
-  - types-tqdm=4.67.0.20241221=pyhd8ed1ab_0
-  - typing_extensions=4.12.2=pyha770c72_1
-  - tzdata=2025a=h78e105d_0
-  - urllib3=2.3.0=pyhd8ed1ab_0
-  - virtualenv=20.29.1=pyhd8ed1ab_0
-  - yaml=0.2.5=h7f98852_2
-  - zipp=3.21.0=pyhd8ed1ab_1
-  - zstandard=0.23.0=py313h80202fe_1
-  - zstd=1.5.6=ha6fb4c9_0
-  - pip:
-      - appdirs==1.4.4
-      - ataraxis-automation==4.0.1
-      - ataraxis-base-utilities==3.0.1
-      - ataraxis-time==3.0.0
-      - build==1.2.2.post1
-      - click==8.1.8
-      - loguru==0.7.2
-      - pyproject-hooks==1.2.0
-      - sphinx-rtd-dark-mode==1.3.0
-      - tox-uv==1.16.0
-      - tqdm==4.67.1
-      - uv==0.5.5
+  - ncurses=6.5=h2d0b736_3
+  - openssl=3.5.4=h26f9b46_0
+  - packaging=25.0=pyh29332c3_1
+  - pip=25.2=pyh145f28c_0
+  - platformdirs=4.4.0=pyhcf101f3_0
+  - pluggy=1.6.0=pyhd8ed1ab_0
+  - pyproject-api=1.9.1=pyhe01879c_0
+  - python=3.13.7=h2b335a9_100_cp313
+  - python-uv=0.8.22=pyhcf101f3_0
+  - python_abi=3.13=8_cp313
+  - readline=8.2=h8c095d6_2
+  - tk=8.6.13=noxft_hd72426e_102
+  - tomli=2.2.1=pyhe01879c_2
+  - tox=4.30.2=pyhcf101f3_0
+  - tox-uv=1.28.0=pyhd8ed1ab_0
+  - typing_extensions=4.15.0=pyhcf101f3_0
+  - tzdata=2025b=h78e105d_0
+  - uv=0.8.22=h30787bc_0
+  - virtualenv=20.34.0=pyhd8ed1ab_0
+