2018.5
Pre-release
Pre-release
Version 0.5.3
This is a reference release that incorporates the past month's changes in importing DDSCAT and ADDA shapes into the icedb format. Shape files discussed in the 5/17/2018 meeting should be constructed using this version.
Penn State snowflakes
Implementation not yet merged with the master branch at time of release. (Last minute changes...)
The 3d_structures_singlethreaded program
This is the reference program for importing shapes.
To import a file or folder (shape.dat, shape.nc) into a database (shape.hdf5):
3d_structures_singlethreaded --from shape.dat --to shape.hdf5
Program options
Group | Option | Input type | Description |
---|---|---|---|
I/O | from | strings | Path where shapes are read from. This may be a list of folders and files. If a directory is encountered, then it is recursively searched for shapes. The recursive search behavior is controlled by the from-matching-extensions option. |
I/O | from-format | string | The format of the input files. The format of the input files. This needs to be specified when the inputs are NetCDF or HDF5 files, as there are multiple conventions for these files that cannot be easily autodetected. Options: text, psu. |
I/O | from-nosearch | boolean | Set this option if you want to read in a set of files whose paths are exactly specified on the command line. This option allows for the finest control of input file selection. |
I/O | from-matching-extensions | strings | Use this to override the extensions of files to match (e.g. .adda .shp) when searching for valid shapes in directories specified in --from. |
I/O | to | string | Path where shapes are written to. |
I/O | db-path | string | The group within the HDF5 database where the new data is written to. |
I/O | create | None | Create the output database if it does not exist. If it does, then exit without writing. |
I/O | truncate | None | Overwrite the output file. If not specified, then an already-existing output file is appended to. |
Metadata | resolution | float | The lattice spacing (in um). |
Metadata | author | string | Name(s) of the person/group who generated the shape. |
Metadata | contact-information | string | Affiliation, Contact information including email of the person/group who generated the scattering data. |
Metadata | scattering-method | string | Method applied to the shape to calculate the scattering properties. |