openPMD/openPMD-api

`Dataset`: ArrayInterface Overload

Open

#1,831 opened on Jan 13, 2026

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
feature requestfrontend: Python3good first issue

Repository metrics

Stars
 (160 stars)
PR merge metrics
 (PR metrics pending)

Description

We could simplify non-MPI Python code if we add another constructor to Dataset:

import openpmd_api as io

data = np.arange(size*size, dtype=np.double).reshape(3, 3)

# now
dataset = io.Dataset(data.dtype, data.shape)

# future
dataset = io.Dataset(data)

Contributor guide

Research direction
Inspect the current Python binding for the Dataset class and understand how constructor overloading works there. Look for how dtype and shape are extracted from Python objects. Review existing Python tests for Dataset to see expected behavior.
Tech stack
pythonnumpy
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitPythonC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75