Extend documentation of examples and supply sample files
It is great that there are some examples on how to use OpenVDS. It would be even more helpful if there would be a short explanation of what each example does, what assumptions are made and, if necessary, that input files would be included. I think that would make life much easier for beginners.
For example, the npz_to_vds.py script is really helpful, but it would be nice if the input file would be provided with the script. It is not immediately clear that what assumptions on the file are made. When I looked into the file first I had the following questions:
-
Why is there a
--npy
command line parameter that is never used? -
Why do the axis descriptors seem to expect x, y and z to be in a certain range [0,2000]?
-
Why is the value range computed in the way it is computed? What is the "correct" way to give a value range? Should it be certain percentiles?
-
Where is the input file or how can I create a valid input file myself?
-
How does writing data via the page accessor actually work and where do I find more information about that?
-
Do I have to use
open
andclose
for interaction with the VDS file or could I also use... with openvds.create( args.url, args.connection, layoutDescriptor, axisDescriptors, channelDescriptors, metaData, compressionMethod, compressionTolerance ) as vds: layout = openvds.getLayout(vds) ... accessor.commit()