Public API when importing PODPAC about podpac HOT 5 CLOSED

I prefer the more categorical/hierarchical approach.

import podpac
['algorithm',
 'algorithmlib',
 'compositor',
 'coordinate',
 'data',
 'datalib',,
 'Node',
 'pipeline',
 'Units',
 'UnitsDataArray',
 'core',
 'settings']

dir(podpac.algorithm)
[
'Algorithm',
'Arithmetic',
 'Convolution',
 'Count',
 'ExpandCoordinates',
 'Kurtosis',
 'Max',
 'Mean',
 'Median',
 'Min',
 'SinCoords',
 'Skew',
 'SpatialConvolution',
 'StandardDeviation',
 'Sum',
 'TimeConvolution',
 'Variance',
]

dir(podpac.compositor)
[
'Compositor',
 'OrderedCompositor',
]

dir(podpac.data)
[
'DataSource', 
'NumpyArray', 
'WCS', 
...
]

dir(podpac.pipeline)
[
 'Pipeline',
 'PipelineError',
]

dir(podpac.coordinate)
[
'Coordinate', 
'Coord', 
'MonotonicCoord', 
'UniformCoord', 
'coord_linspace', 
...
]

etcetera.

from podpac.

@jmilloy @mlshapiro @drc-creare and DS what do you think?

from podpac.

I wouldn't be strict one way or the other.

Note that providing a flat structure doesn't prevent nested use (e.g. you can use either Median or algorithm.Median or algorithm.stats.Algorithm in a pipeline), but I do think that the toplevel namespace will get too cluttered.

Currently we have a mix: for example, the nodes in the various algorithm submodules are all exposed at the algorithm level (so not entirely flattened but not entirely nested either), which I think makes sense. So I would honestly expose highly common things at the podpac level (e.g. from podpac import Coordinate, but from podpac.core.coordinate import Coord).

from podpac.

(This made me think about the np.array method, which is fairly general and returns an np.ndarray object, and using that as a model for Coordinate. I would love to simplify the podpac.core.coordinate.Coordinate class and require more explicit arguments during initialization (UniformCoord instead of a tuple, np.datetime64 instead of strings) with a toplevel popdac.coordinate function that accepts all of the various shortcuts that make it easy to use and returns a Coordinate type. Any thoughts on that?)

from podpac.

Documented in contributing in cbaa498

from podpac.