run_analysis

Analyze Locally

sonnetsuiteshelper.run_analysis.analyze_local(project_name: str, sonnet_install_loc: str, display_analysis_info_live: bool = False, lossles: bool = False, abs_cache_none: bool = False, abs_cache_stop_restart: bool = False, abs_cache_multi_sweep: bool = False, abs_no_discrete: bool = False, sub_freq_Hz: int | None = None, param_file: str = '')[source]

Send a file to the local Sonnet Suites Solver.

Parameters:

  • project_name (str) – The name of the sonnet file to be analyzed. If this does not include the “.son” file extention then it will be added.

  • sonnet_install_loc (str) – This the directory of the sonnet install. This is needed to know the location of the em executable to be able to run the analysis. This is usually for windows: >>> C:/Program Files/Sonnet Software/XX.XX where ‘XX.XX’ is the version number, e.g. “…/Sonnet Software/17.56”.

  • display_analysis_info_live (bool) – Whether to display live analysis info in the terminal.

  • lossles (bool) – Default False

  • abs_cache_none (bool) – Default False,

  • abs_cache_stop_restart (bool = False,) – Default False

  • abs_cache_multi_sweep (bool = False,) – Default False

  • abs_no_discrete (bool = False,) – Default False

  • sub_freq_Hz (int | None = None,) – Default None

  • param_file (str = "",) – Default is blank str

See also

analyze_remote

remote server analysis.

Referencees

Analyze Remotely

sonnetsuiteshelper.run_analysis.analyze_remote(project_name: str, remote_host: str, remote_port: str, param_file: str = '')[source]

Send a file to a remote emsolver server for analysis.

Parameters:

  • project_name (str) – This is the name of the sonnet file to be analyzed. If this does not include the .son file extention it will be added.

  • remote_host (str) – This is the host name for the remote solver. e.g. “10.1.10.30”

  • remote_port (str) – This is the port to be used to connect to the remote solver. e.g. “56150”

Keyword Arguments:

param_file (str) – This is a parameter file name for a project. This should include the path for the file and the file extention.