-
Notifications
You must be signed in to change notification settings - Fork 7
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
Repo organization #6
Comments
@iled This looks good to me! The one thing I would add is a |
I agree that is very helpful to check and play with others code---that is the good thing of open source! Although, I think it is not that helpful to have a For that purpose, and to try to make it more like a sandbox, I would recommend others fork the repo and then create any needed folders, or, at least, create a branch in the main repo for that purpose. That way, contributors would have the choice to pull additional code or keep it to the essential. In either case, pull requests could be made to bring useful code back to the main repo/branch! Anyway, these are just suggestions, I am not vetoing anything! |
Here is a proposal for a directory structure for the repo.
I realize this should have been earlier last week, so my apologies.
. (root)
.. coastal : where all the code lives. usually named after the project, so it could be coastal_topobathy or something else related. subdirectories can be added if complexity increases.
.. data : store relevant data that is to be reused, e.g., vector data that define ROIs (small-ish files only)
.. doc : all the project documentation, e.g., instructions, references
.. examples : notebooks with demos.
The text was updated successfully, but these errors were encountered: