discovery

Discovers Comsol installations.

This is an internal helper module that is not part of the public API. It retrieves information about installed Comsol versions, i.e. available simulation back-ends, and locates the installation folders.

On Windows, the discovery mechanism relies on the Registry to provide information about install locations. On Linux and macOS, Comsol is expected to be installed at its respective default location. Though on Linux, the folder .local in the user’s home directory is also searched to allow symbolic linking to a custom location.

parse(version)[source]

Parses version information as returned by Comsol executable.

Returns (name, major, minor, patch, build) where name is a string and the rest are numbers. The name is a short-hand based on the major, minor, and patch version numbers, e.g. '5.3a'.

Raises ValueError if the input string deviates from the expected format, i.e., the format in which the Comsol executable returns version information.

search_Windows()[source]

Searches for Comsol installations on a Windows system.

search_Linux()[source]

Searches for Comsol installations on a Linux system.

search_macOS()[source]

Searches for Comsol installations on a macOS system.

search_system()[source]

Searches the system for Comsol installations.

backend(version=None)[source]

Returns information about the Comsol back-end.

A specific Comsol version can be selected by name if several are installed, for example version='5.3a'. Otherwise the latest version is used.