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.

Sign up for GitHub

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

Jump to bottom

FRQ: 2.0.0 base changes #100

Open
kay-ro opened this issue Feb 3, 2025 · 1 comment
Open

FRQ: 2.0.0 base changes #100

kay-ro opened this issue Feb 3, 2025 · 1 comment
Labels
documentation Improvements or additions to documentation module: base module: load module: reader module: trajectory new feature New feature release: major Issues that need or may be better addressed in a major release release: minor Issues that need to be addressed in a minor release status: under discussion Not clear if it should be implemented
Milestone
release v2.0.0

Comments

@kay-ro
Copy link
Member

kay-ro commented Feb 3, 2025 •
edited
Loading

Proposed new feature or change:

At the moment the FieldTrajectory is created by the ContinuumReader. This might be confusing when trying to find related functions in the documentation.
The ContinuumReader could be renamed to FieldReader in order to make the package more uniform.

This could also be implemented as minor release by copying the ContinuumReader and renaming it to FieldReader with an additional FutureDeprecationWarning added in the appropriate places.

Might also be applied to re-organize base.BaseField (Field data) and base.BaseFrame (Particle data)?
@kay-ro kay-ro added documentation Improvements or additions to documentation module: base module: load module: reader module: trajectory new feature New feature release: major Issues that need or may be better addressed in a major release release: minor Issues that need to be addressed in a minor release status: under discussion Not clear if it should be implemented labels Feb 3, 2025
@kay-ro kay-ro modified the milestones: release v1.1.0, release v2.0.0 Feb 3, 2025
@kay-ro kay-ro changed the title FRQ: simplify notation of Field and Continuum FRQ: 2.0.0 base changes Feb 5, 2025
@kay-ro
Copy link
Member Author

kay-ro commented Feb 5, 2025 •
edited by kai-luca
Loading

Major release 2.0.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation module: base module: load module: reader module: trajectory new feature New feature release: major Issues that need or may be better addressed in a major release release: minor Issues that need to be addressed in a minor release status: under discussion Not clear if it should be implemented
Projects
None yet
Milestone
release v2.0.0
Development

No branches or pull requests
1 participant
@kay-ro