search

NOAA-OWP / hydrotools

Suite of tools for retrieving USGS NWIS observations and evaluating National Water Model (NWM) data.
Other
54 stars 14 forks source link

Events package structure question #141

Open aaraney opened 3 years ago

aaraney commented 3 years ago

I noticed while looking around the package today that the event_detection module is nested one level deeper than typical and does not have a parent subsubpackage (directory above with __init__.py).

More concretely, on the path hydrotools/python/events/src/hydrotools/events/event_detection/, there is an __init__.py in the event_detection directory but not in the events directory. @jarq6c can you clarify why this is the case? I assume there should be an __init__.py in the events directory as well.

Thanks!

jarq6c commented 3 years ago

I think we had originally discussed adding various subpackages under events, but we never decided if events was going to be a proper package or another namespace package.

aaraney commented 3 years ago

Do you have an opinion on the future of the events package? I am happy to retain it as it's own namespace package (as it is now). However, I am equally happy to keep it the way it is for flexibility in the future.

jarq6c commented 3 years ago

No strong opinions at this point. My preference might be to leave it, unless there's a compelling reason to change it. I would rather future development guide what we do, say when/if different event based analysis methods get added like events.event_analysis or the like.