h5sample¶
Module to sample an COMPAS h5 file.
This allows users to sample a COMPAS h5 file to contain a smaller set of systems, or upsample a COMPAS h5 file (sample with replacements) to contain a larger set of systems.
Command line interface for h5sample¶
Sample an COMPAS h5 file.
usage: compas_h5sample [-h] [--output_filepath OUTPUT_FILEPATH] [--n N]
[--frac FRAC] [--replace REPLACE]
[--seed_group SEED_GROUP] [--seed_key SEED_KEY]
compas_h5_filepath
Positional Arguments¶
- compas_h5_filepath
Path to the COMPAS h5 file.
Named Arguments¶
- --output_filepath
Path to the output COMPAS h5 file. If None, the output filepath will be the input filepath with '_sampled' appended.
- --n
Number of binaries to sample.
- --frac
Fraction of binaries to sample.
- --replace
Sample with or without replacement.
Default: False
- --seed_group
Group to get binary seed list to sample from.
Default: "Run Details"
- --seed_key
Key to get binary seed list to sample from.
Default: "SEED"