Module functions

mstar.Load(fn='')

Load a msb document.

Parameters:

fn (str) – The file name to load. If argument is an empty string (the default), returns a new empty model.

Returns:

The mstar model MStarModel

mstar.LoadFromCatalog(name='')

Load a msb document from the built-in catalog

Parameters:

fn (str) – The name to load

Returns:

The mstar model MStarModel

mstar.CheckOutLicense()

Check out an M-Star pre-processing license. Required to do any processing

mstar.SetVerbose()

Enable verbose printing

mstar.ListComponentTypes()
Returns:

The available component types that can be created using the AddComponent methods

Return type:

list

mstar.SetLogVerbosity(level)

Change what type of messages show up in the log. By default all messages show up in the log except for verbose messages.

Values:

  • 1 : Errors

  • 2 : Warnings

  • 9 : All messages

Parameters:

level (int) – Max level to report to log.

mstar.EnableLogging(value)

Enable logging to standard output. Log is disabled by default.

Parameters:

value (bool) – Enable or disable logging