pyfar / pyfar/sofar

sofar: Refactoring - Roadmap for sofar 1.4.0

Open
#123 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement feature
Dominant language
Python
Stars
34
Forks
4
Avg merge
11m
Merged PRs (30d)
2

Description

Suggested behavior:

  • Add Sofa.convantion_status property that returns 'current', 'preliminary' or 'deprecated'

Reading SOFA files and creating Sofa objects

  • Don't raise warnings if reading preliminary or deprecated conventions anymore. Thats cluttering the command line and is only important when writing
  • Verify preliminary conventions. They should become stable at some point and errors should come up to be fixed. They are currently not verified. I forgot the reason for this.

Writing SOFA files

  • Print information about custom variables with the information that users should check if they are necessary of information should be moved to standardized variables.
  • Make printouts optional via a verbose flag
  • Improve warning message for preliminary convention. Currently it is mentioned that conventions should be updated if possible. Which is actually not possible.

Updates in conventions

  • [ ] Update conventions, code, and testing once the conventions are released (see #112)

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 SOFA reading and writing paths, convention handling, and existing tests; check issue #112 for the pending convention release. Treat the checklist as a roadmap: done means the convention status, warning and verbose behavior, custom-variable messaging, and released-convention updates are implemented and covered by tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.