Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] Limit number of chunks used when exporting dataset to netcdf #5524

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
35 changes: 29 additions & 6 deletions src/qcodes/dataset/data_set.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@
from threading import Thread
from typing import TYPE_CHECKING, Any, Literal

import cf_xarray as cfxr
import numpy
from tqdm.auto import trange
from tqdm.auto import tqdm

import qcodes
from qcodes.dataset.data_set_protocol import (
Expand Down Expand Up @@ -246,7 +247,8 @@ def __init__(
#: In memory representation of the data in the dataset.
self._cache: DataSetCacheWithDBBackend = DataSetCacheWithDBBackend(self)
self._results: list[dict[str, VALUE]] = []
self._in_memory_cache = in_memory_cache
self._in_memory_cache: bool = in_memory_cache
self._max_num_files_export = 100
self._export_limit = 1000

if run_id is not None:
Expand Down Expand Up @@ -1484,6 +1486,21 @@ def _set_export_info(self, export_info: ExportInfo) -> None:

def _export_as_netcdf(self, path: Path, file_name: str) -> Path:
"""Export data as netcdf to a given path with file prefix"""

def generate_steps(num_rows, max_num_steps) -> list[tuple[int, int]]:
if max_num_steps >= num_rows:
return [(i + 1, i + 1) for i in range(num_rows)]

step_size, remainder = divmod(num_rows, max_num_steps)
limits = [
(i * step_size + 1, (i + 1) * step_size) for i in range(max_num_steps)
]

if remainder > 0:
limits[-1] = (limits[-1][0], (step_size) * max_num_steps + remainder)

return limits

import xarray as xr

file_path = path / file_name
Expand Down Expand Up @@ -1514,16 +1531,22 @@ def _export_as_netcdf(self, path: Path, file_name: str) -> Path:
"temp_dir": temp_dir,
},
)
num_files = len(self)
num_rows = len(self)
steps = generate_steps(num_rows, self._max_num_files_export)
num_files = len(steps)
num_digits = len(str(num_files))
file_name_template = f"ds_{{:0{num_digits}d}}.nc"
for i in trange(num_files, desc="Writing individual files"):
for i, (start, stop) in tqdm(
enumerate(steps), total=num_files, desc="Writing individual files"
):
xarray_to_h5netcdf_with_complex_numbers(
self.to_xarray_dataset(start=i + 1, end=i + 1),
self.to_xarray_dataset(start=start, end=stop),
temp_path / file_name_template.format(i),
)
files = tuple(temp_path.glob("*.nc"))
data = xr.open_mfdataset(files)
data = xr.open_mfdataset(
files, preprocess=cfxr.coding.decode_compress_to_multi_index
)
try:
log.info(
"Combining temp files into one file.",
Expand Down
12 changes: 10 additions & 2 deletions tests/dataset/test_dataset_export.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@
import os
from pathlib import Path

import hypothesis.strategies as hst
import numpy as np
import pytest
import xarray as xr
from hypothesis import HealthCheck, given, settings
from numpy.testing import assert_allclose
from pytest import LogCaptureFixture, TempPathFactory

Expand Down Expand Up @@ -826,11 +828,17 @@ def test_export_dataset_small_no_delated(
assert "Writing netcdf file directly" in caplog.records[0].msg


@settings(
deadline=None,
suppress_health_check=(HealthCheck.function_scoped_fixture,),
)
@given(max_num_files=hst.integers(min_value=1, max_value=55))
def test_export_dataset_delayed_numeric(
tmp_path_factory: TempPathFactory, mock_dataset_grid: DataSet, caplog
max_num_files, tmp_path_factory: TempPathFactory, mock_dataset_grid: DataSet, caplog
) -> None:
tmp_path = tmp_path_factory.mktemp("export_netcdf")
tmp_path = tmp_path_factory.mktemp(f"export_netcdf_{max_num_files}")
mock_dataset_grid._export_limit = 0
mock_dataset_grid._max_num_files_export = max_num_files
with caplog.at_level(logging.INFO):
mock_dataset_grid.export(export_type="netcdf", path=tmp_path, prefix="qcodes_")

Expand Down