plot_property

Command-line usage

usage: cell plot_property [-h] [-gss None] [-model-filepath None] [-output 1]
                          [-fn None] [-fdn None] [-mm] [-y None] [-loo]
                          [-ymin None] [-ymax None]
                          sset_filepath property_name

positional arguments:
  sset_filepath         Path to file of serialized StructuresSet object.
  property_name         Name of the property to be plotted.

options:
  -h, --help            show this help message and exit
  -gss, --sset-gss-filepath None
                        Path to file of serialized StructuresSet object for GS
                        structures.
  -model-filepath None  Path to file of serialized Model object.
  -output 1             How to output the plot. 1: show, 2: save, 3: both.
  -fn, --fig-fname None
                        Filepath to save generated figure if output is 2 or 3.
  -fdn, --figdata-fname None
                        Filepath to save the data used to generate the figure.
                        Possible extensions: .npz, .json, .txt, .dat.
  -mm, --mark-min       Mark points with the lowest property value (e.g.
                        ground states).
  -y, --y-axis-label None
                        Label for the y-axis of the plot.
  -loo, --show-loo-predictions
                        Show Leave-One-Out cross-validation predictions.
  -ymin None            Minimum y-value for the plot axis.
  -ymax None            Maximum y-value for the plot axis.

Arguments and behavior

clusterx.cli.plot_property.plot_property(sset_filepath, property_name, sset_gss_filepath=None, model_filepath=None, output=1, fig_fname=None, figdata_fname=None, mark_min=False, y_axis_label=None, show_loo_predictions=False, ymin=None, ymax=None)

Make plot of property versus concentration