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

More modules / hierarchical code structure #456

Closed
glwagner opened this issue Oct 10, 2019 · 0 comments · Fixed by #591
Closed

More modules / hierarchical code structure #456

glwagner opened this issue Oct 10, 2019 · 0 comments · Fixed by #591

Comments

@glwagner
Copy link
Member

We may want to consider modularizing our code a bit more; for example we could have a Diagnostics module, an OutputWriters module, etc, with folders that correspond to the module name, and with module functionality split into multiple files.

This may make the source code more navigable and also create some opportunities for a clearer API, since we can selectively export different functionality from Oceananigans than from Oceananigans.Diagnostics (for example). In other words, we could write the API so that using Oceananigans brings only bare-bones diagnostics functionality into scope for users, while using Oceananigans.Diagnostics brings a full-fledged suite of diagnostics functionality into scope if that is desired.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant