hoomd.option

Overview

hoomd.option.get_user Get user options.
hoomd.option.set_autotuner_params Set autotuner parameters.
hoomd.option.set_msg_file Set the message file.
hoomd.option.set_notice_level Set the notice level.

Details

Set global options.

Options may be set on the command line or from a job script using hoomd.context.initialize(). The option.set_* commands override any settings made previously.

hoomd.option.get_user()

Get user options.

Returns:List of user options passed in via –user=”arg1 arg2 ...”
hoomd.option.set_autotuner_params(enable=True, period=100000)

Set autotuner parameters.

Parameters:
  • enable (bool) –
  • period (int) – Approximate period in time steps between retuning.

TODO: reference autotuner page here.

hoomd.option.set_msg_file(fname)

Set the message file.

Parameters:fname (str) – Specifies the name of the file to write. The file will be overwritten. Set to None to direct messages back to stdout/stderr.

The message file may be changed before or after initialization, and may be changed many times during a job script. Changing the message file will only affect messages sent after the change.

Note

Overrides --msg-file on the command line.

hoomd.option.set_notice_level(notice_level)

Set the notice level.

Parameters:notice_level (int) –

The notice level may be changed before or after initialization, and may be changed many times during a job script.

Note

Overrides --notice-level on the command line.