idies / pyJHTDB

Python wrapper for the Johns Hopkins turbulence database library
Apache License 2.0
100 stars 47 forks source link

add documentation #13

Closed petebachant closed 5 years ago

petebachant commented 9 years ago

If one uses a single point, e.g. a 3-tuple as input, this will fail, but one could easily put this inside the function before checking for the proper shape:

points = np.asarray(points, dtype=np.float32)
chichilalescu commented 9 years ago

as per the discussion for #14, basic functionality should be well documented. i.e. add the stuff that sphinx api-doc would like to see.