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

Different namespace for different uses #103

Open
TomNicholas opened this issue Aug 29, 2024 · 1 comment
Open

Different namespace for different uses #103

TomNicholas opened this issue Aug 29, 2024 · 1 comment
Labels
question Further information is requested

Comments

@TomNicholas
Copy link
Member

TomNicholas commented Aug 29, 2024

Eventually roms-tools will cover setting up input files, but also analysing them, as well as miscellaneous utilities. I think it would be neater to separate these uses into different namespaces, i.e. roms_tools.setup, roms_tools.analysis, and roms_tools.utils. This would require changing the current top-level imports of Grid etc. to be from roms_tools.setup import Grid etc. instead.

This suggestion assumes that there is no use for the Grid etc. classes in the analysis steps?

@NoraLoose
Copy link
Collaborator

The only class that may be relevant for analysis steps is actually Grid because Grid.ds holds all relevant coordinate information. A lot of this coordinate information is not needed by ROMS itself, but is there for the user so they are able to do analysis, e.g., lat / lon at u- and v-points and vertical coordinate info.

That being said, the content of Grid.ds is written to a NetCDF file, which the analysis classes could read in if they don't want to rely on Grid. But it would be nicer to have them depend on the Grid class I think.

@NoraLoose NoraLoose added the question Further information is requested label Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants