V1.0.8 - Introduce BulkReader

[totonga]

This release introduces a new utility module for bulk reading, updates dependencies and actions, and improves documentation and development tooling. The most significant change is the addition of the BulkReader class, which provides convenient methods for loading and processing local column data in bulk. Additionally, the ConI class is extended to expose this new functionality. Other changes include dependency and GitHub Actions updates, as well as minor documentation and configuration improvements.

Load Bulk

Load Submatrix

from odsbox.con_i import ConI
import pandas as pd
import matplotlib.pyplot as plt

with ConI(url=url, auth=auth, verify_certificate=False) as con_i:

    submatrix_id = con_i.query_data(
        {
            "AoSubmatrix": {"measurement.name": "Profile_52"},
            "$options": {"$rowlimit": 1},
            "$attributes": {"id": 1},
        }
    ).iloc[0, 0]

    bulk1_df: pd.DataFrame = con_i.bulk.data_read(submatrix_id, ["Time", "Coola*"])
    bulk2_df: pd.DataFrame = con_i.bulk.valuematrix_read(submatrix_id, ["Time", "Coola*"])

_ = bulk1_df.plot(subplots=True)
_ = bulk2_df.plot(subplots=True)

Load Local Columns

from odsbox.con_i import ConI
from matplotlib import pyplot as plt

with ConI(url=url, auth=auth, verify_certificate=False) as con_i:
    conditions = {"submatrix.measurement.name": {"$like":"Profile_5?"}}
    con_i.bulk.add_column_filters(conditions, ["Time", "Coolant"], False)
    print(conditions)
    bulk_compare_df = con_i.bulk.query(
        conditions)


fig, ax = plt.subplots(figsize=(15, 10))

for submatrix, group in bulk_compare_df.groupby('submatrix'):
    s = group.set_index('name')['values']
    if {'Time', 'Coolant'}.issubset(s.index):
        ax.plot(s['Time'], s['Coolant'], label=f'Submatrix {submatrix}', alpha=0.7)

ax.set_xlabel('Time')
ax.set_ylabel('Coolant')
ax.set_title('Coolant over Time for All Submatrices')
ax.legend()
ax.grid(True, alpha=0.3)
plt.tight_layout()
plt.show()

Details

Bulk reading functionality:

• Added new src/odsbox/bulk_reader.py module, introducing the BulkReader class for efficient bulk data loading and processing, including support for sequence representations and integration with pandas.
• Integrated BulkReader into the ConI class in src/odsbox/con_i.py, with a new bulk property for accessing bulk reading methods, proper initialization and cleanup, and import statements. [1] [2] [3] [4]

Documentation:

• Added API documentation for the new bulk_reader module in docs/odsbox.rst.

Miscellaneous:

• Added new terms to .vscode/settings.json spell-checker dictionary to reduce false positives.
• Improved coverage of jaquel unit tests.

What's Changed

• feat: 143 add bulkreader by @totonga in feat: 143 add bulkreader #144
• feat: Added BulkReader by @totonga in feat: Added BulkReader #145
• fix: bump actions/checkout from 4.2.2 to 5.0.0 by @dependabot[bot] in fix: bump actions/checkout from 4.2.2 to 5.0.0 #138
• fix: bump shellcheck-py from 0.10.0.1 to 0.11.0.1 by @dependabot[bot] in fix: bump shellcheck-py from 0.10.0.1 to 0.11.0.1 #139
• fix: bump pylint from 3.3.7 to 3.3.8 by @dependabot[bot] in fix: bump pylint from 3.3.7 to 3.3.8 #140
• fix: bump pre-commit from 4.2.0 to 4.3.0 by @dependabot[bot] in fix: bump pre-commit from 4.2.0 to 4.3.0 #141
• fix: bump amannn/action-semantic-pull-request from 5.5.3 to 6.0.1 by @dependabot[bot] in fix: bump amannn/action-semantic-pull-request from 5.5.3 to 6.0.1 #142

Full Changelog: v1.0.7...v1.0.8