PlasmaPy / PlasmaPy/pyfaradaycup

Add a testing utility to facilitate comparisons of CDF files

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

Nobody has claimed this yet.

Dominant language
Python
Stars
1
Forks
1
Avg merge
18h 31m
Merged PRs (30d)
20

Description

One of my goals is to add regression tests to make sure that each step in the new pipeline matches the output from the old. While this will be useful to make sure that things are working, by itself this will not be useful for tracking down how the new output differs from the original.

To that end, it would be helpful to have helper functionality that will produce useful output to show how the files differ.

Reading the CDF file into an xarray object would hopefully let us make use of functionality already available across the scientific pythoniverse. If I'm remembering right, we could likely do this with cdflib. I'll have to look into which tools already exist.

Contributor guide

No contributing guide indexed for this repository

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

No files or tests are named. Start by locating the existing pipeline regression tests and the code that reads or writes CDF files, then assess whether xarray and cdflib provide the needed comparison support. Done means a reusable testing utility produces useful output showing how an original CDF differs from new pipeline output.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data, testing-qa
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.