trixi-framework / trixi-framework/TrixiParticles.jl

Add unit tests for `write_meta_data()` functionality

Open
#848 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Julia
Stars
83
Forks
24
Avg merge
8d 18h
Merged PRs (30d)
3

Description

A function to write simulation meta_data to a JSON file has been implemented. However, unit tests for this functionality are still missing. The implementation of these tests will follow as soon as the meta_data can be read by the vtk2trixi() function.

See PR #737

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the write_meta_data() implementation and the vtk2trixi() reader, then inspect PR #737 for the intended metadata format. Add unit tests once the metadata can be read by vtk2trixi(), and consider the work done when the JSON-writing behavior is covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
testing-qa
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.