openPMD/openPMD-api

Patches Load: Exception Handling

Open

#750 opened on Jun 5, 2020

View on GitHubContributor guide
 (0 comments) (0 reactions) (0 assignees)C++ (57 forks)auto 404
affects latest releasebugfrontend: Python3good first issuehelp wanted

Repository metrics

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

Description

Describe the bug Loading a non-existent particle patch should not segfault but throw (in Python).

Generally, try to derive and document a high-level workflow to deal with particle patches for scripts and frameworks such as ParaView.

To Reproduce https://github.com/ComputationalRadiationPhysics/particle_reduction/issues/8

Expected behavior Throw an exception and add simple probing functionality or high-level iterators.

Software Environment

  • version of openPMD-api: 0.11.0-alpha
  • installed openPMD-api via: all
  • operating system: Ubuntu Linux 18.04 / all
  • machine: local laptops / all
  • name and version of Python implementation: CPython 3.7/3.8
  • version of HDF5: N/A
  • version of ADIOS1: N/A
  • version of ADIOS2: N/A
  • name and version of MPI: N/A

Additional context Related to report in https://github.com/ComputationalRadiationPhysics/particle_reduction/issues/8

Contributor guide

Research direction
Investigate how particle patches are loaded in the C++ core and Python API. Reproduce the crash, find where exceptions are lost, and explore adding simple probing and iterators. Check existing exception handling patterns.
Tech stack
python
Domain
dataapi
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC++Python
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40