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

Dataset-specific JSON/TOML configuration #1646

Open
wants to merge 12 commits into
base: dev
Choose a base branch
from

Conversation

franzpoeschel
Copy link
Contributor

@franzpoeschel franzpoeschel commented Jul 10, 2024

This was initially prototyped in PIConGPU, search for "extended format for JSON options" on this documentation page.

This moves that functionality over into openPMD.
Look at the diff on examples/13_write_dynamic_configuration.cpp for an example use case.
Bringing this to openPMD makes this functionality available in codes other than PIConGPU, and makes it available from TOML as well as from JSON.

TODO:

  • Document
  • Test
  • The NVIDIA compiler cant reliably parse TOML, don't let it run example 13

@franzpoeschel franzpoeschel added the api: new additions to the API label Jul 10, 2024
@franzpoeschel franzpoeschel force-pushed the dataset-specific-config branch 2 times, most recently from 3d5b70a to 37d57ab Compare July 10, 2024 11:23
src/IO/AbstractIOHandler.cpp Fixed Show fixed Hide fixed
and is interpreted as a regular expression against which the dataset name
(full path or path within an iteration) must match.)END";
auto throw_up = [&](std::string const &additional_info,
auto &&...additional_path) {

Check notice

Code scanning / CodeQL

Unused local variable Note

Variable additional_path is not used.
and is interpreted as a regular expression against which the dataset name
(full path or path within an iteration) must match.)END";
auto throw_up = [&](std::string const &additional_info,
auto &&...additional_path) {

Check notice

Code scanning / CodeQL

Unused static variable Note

Static variable additional_path is never read.
and is interpreted as a regular expression against which the dataset name
(full path or path within an iteration) must match.)END";
auto throw_up = [&](std::string const &additional_info,
auto &&...additional_path) {

Check notice

Code scanning / CodeQL

Declaration hides parameter Note

Local variable 'additional_path' hides a
parameter of the same name
.

namespace
{
auto readPattern(

Check warning

Code scanning / CodeQL

Poorly documented large function Warning

Poorly documented function: fewer than 2% comments for a function of 101 lines.
@franzpoeschel franzpoeschel force-pushed the dataset-specific-config branch 4 times, most recently from c95a953 to 68dc005 Compare July 16, 2024 11:12
std::string merge_impl(
std::string const &defaultValue,
std::string const &overwrite,
MPI_Comm_t &&...comm)

Check notice

Code scanning / CodeQL

Unused local variable Note

Variable comm is not used.
std::string merge_impl(
std::string const &defaultValue,
std::string const &overwrite,
MPI_Comm_t &&...comm)

Check notice

Code scanning / CodeQL

Unused static variable Note

Static variable comm is never read.
@ax3l ax3l modified the milestones: 0.16.0, 0.17.0 Jul 16, 2024
@ax3l ax3l self-requested a review July 16, 2024 17:23
@franzpoeschel franzpoeschel force-pushed the dataset-specific-config branch 2 times, most recently from c0f942e to fb7a28e Compare July 19, 2024 09:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: new additions to the API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants