Installation and Licensing: Difference between revisions

From Met Dynamics
Jump to navigation Jump to search
m (1 revision imported)
md>Scott.Munro
mNo edit summary
Line 7: Line 7:
Met Dynamics software may be installed by following the procedures provided in this section:
Met Dynamics software may be installed by following the procedures provided in this section:
* Manual installation steps are provided in lieu of an installer program, which may be restricted in some security environments.
* Manual installation steps are provided in lieu of an installer program, which may be restricted in some security environments.
* Some basic knowledge of file manipulation in Microsoft Windows is required to complete installation.
* Some basic knowledge of file manipulation in Microsoft Windows is required to complete the installation.
* Administrator rights are not required to install or use Met Dynamics software.


=== System requirements ===
=== System requirements ===
Line 18: Line 17:
* (Optional) {{Version (Text, mdModels2, SysCAD)}}
* (Optional) {{Version (Text, mdModels2, SysCAD)}}


=== Excel installation ===
Administrator rights are not required to install or use Met Dynamics software.
 
=== Distribution package ===
 
Met Dynamics software is distributed as a ''zip'' archive file. The zip archive contains versions of the software for all available interfaces (e.g. Excel, SysCAD).
 
To obtain the latest distribution, please contact [mailto:support@metdynamics.com.au support@metdynamics.com.au]
 
=== Step One: Excel installation ===
 
Met Dynamics software may be installed for Microsoft Excel by undertaking the following steps:
# Unzip the contents of ''mdModels2.zip'' into ''C:\mdModels2'' (recommended) or your preferred folder
# Unzip the contents of ''mdModels2.zip'' into ''C:\mdModels2'' (recommended) or your preferred folder
# Start Microsoft Excel
# Start Microsoft Excel
Line 25: Line 34:
# Ensure ''Manage'' is set to ''Excel Add-Ins'' and click ''Go''
# Ensure ''Manage'' is set to ''Excel Add-Ins'' and click ''Go''
# Select ''Browse'' and navigate to your installation path (e.g. ''C:\mdModels2'')
# Select ''Browse'' and navigate to your installation path (e.g. ''C:\mdModels2'')
# For 64 bit versions of Excel (default Office install), select the file ''mdModels2.xll'' and choose ''Ok''
# For 64 bit versions of Excel (default Office install), select the file ''{{Name (Text, mdModels2, Excel, 64)}}'' and choose ''Ok''
# For 32 bit versions of Excel, select the file ''mdModels2_32.xll'' and choose ''Ok''
# For 32 bit versions of Excel, select the file ''{{Name (Text, mdModels2, Excel, 32)}}'' and choose ''Ok''
# Return to the Excel worksheet window
# Return to the Excel worksheet window
# Enter the formula ''=mdLicense()'' in any cell and press Enter
# Enter the formula ''=mdLicense()'' in any cell and press Enter
# Confirm software license information is displayed (including the ''Site Code'' field, required for licensing)
# Confirm the software license information is displayed and the ''License status'' field is ''LICENSE_OK'' on the ''About'' tab or ''General Message Log''
# If the software is not licensed, please proceed to the [[Installation and Licensing#Licensing|Licensing]] section below for instructions on obtaining a license.
 
=== Step Two (Optional): SysCAD installation ===


=== SysCAD installation ===
It is recommended that Met Dynamics software is installed for Microsoft Excel and the license is confirmed before installing the SysCAD interface.
Using Windows Explorer or a command prompt:
# Copy the ''ScdMD.dll'' file from your Met Dynamics software installation path (e.g. ''C:\mdModels2'') to the SysCAD ''bin'' folder (e.g. ''C:\SysCAD139\bin'')
# Copy the ''mdModels2.lic'' file from your Met Dynamics software installation path (e.g. ''C:\mdModels2'') to the SysCAD ''License'' folder (e.g. ''C:\SysCAD139\License'')
# Start SysCAD and open an existing project that utilises the Met Dynamics Integrated Library, or insert a Met Dynamics model into a newly created project as described in [[Getting started]]
# Open the SysCAD Access window for the Met Dynamics unit model and click on the ''About'' tab
# Confirm license information is displayed in the licensing data fields


'''Note''': The ''ScdMD.dll'' library is compiled against a specific SysCAD Build version, as noted in the [[Revision History]]. As such, SysCAD projects utilising Met Dynamics models may cease to load if the SysCAD version is upgraded without the corresponding version of ''ScdMD.dll''.
To install the {{Name (Text, mdModels2, SysCAD)}}, please use Windows Explorer or a command prompt to undertake the following steps:
# Copy the ''{{Name (Text, mdModels2, SysCAD, DLL)|ext=1}}'' file from your Met Dynamics software installation path (e.g. ''C:\mdModels2'') to the SysCAD ''bin'' folder (e.g. ''C:\SysCAD139\bin'')
# Start SysCAD and open an existing project that utilises the {{Name (Text, mdModels2, SysCAD)}}, or create a new configuration file and project as described in [[Getting started]]
# View the ''General Message Log'' in the SysCAD [https://help.syscad.net/Message_Window Message Window] and locate the text section beginning with "{{Name (Text, mdModels2, SysCAD)}}..."
# Confirm the software license information is displayed and the ''License status'' field is ''LICENSE_OK''
# If the software is not licensed and the ''License location'' field does not point to a valid license file:
## Open the SysCAD Access window for an existing Met Dynamics unit model, or insert a new model if none are present
## Click on the ''About'' tab
## Click the ''Browse'' button and use the file explorer to select a valid license file
## Confirm the software license information is displayed and the ''License status'' field is ''LICENSE_OK''
# If the ''General Message Log'' reports "WARNING: SysCAD Runtime license or /rt command line argument required for Met Dynamics 'SysCAD Runtime' license level", then the Met Dynamics software is licensed for runtime use only. Please obtain a [https://help.syscad.net/SysCAD_License_Options#Full_and_Runtime_Licenses runtime license for SysCAD] or start the SysCAD application in [https://help.syscad.net/Command_Line_Options runtime mode]
# If the software is otherwise not licensed, please proceed to the [[Installation and Licensing#Licensing|Licensing]] section below for instructions on obtaining a license.
 
'''Note''': The ''{{Name (Text, mdModels2, SysCAD)}}'' is compiled against a specific SysCAD Build version, as noted in the [[Revision History]]. As such, SysCAD projects utilising Met Dynamics models may cease to load if the SysCAD version is upgraded without the corresponding version of ''{{Name (Text, mdModels2, SysCAD, DLL)|ext=1}}''.


== Licensing ==
== Licensing ==
Line 49: Line 68:
=== Obtaining a license ===
=== Obtaining a license ===
The steps below outline the procedure for obtaining a license for Met Dynamics software:
The steps below outline the procedure for obtaining a license for Met Dynamics software:
# Install the ''mdModels2.xll'' add-on for Microsoft Excel, as described above
# Install Met Dynamics software for Microsoft Excel, as described [[Installation and Licensing#Step One: Excel installation|above]]
# Start Microsoft Excel
# Start Microsoft Excel
# Enter the formula ''=mdLicense()'' in any cell and press Enter
# Enter the formula ''=mdLicense()'' in any cell and press Enter
# ''Copy'' the string of characters displayed next to the ''Site Code'' field to the Windows Clipboard
# ''Copy'' the string of characters displayed next to the ''Site Code'' field to the Windows clipboard
# Close Microsoft Excel
# Close Microsoft Excel
# ''Paste'' the Site Code character string into the body of a new email message  
# ''Paste'' the Site Code character string into the body of a new email message  
Line 61: Line 80:
# Start Microsoft Excel
# Start Microsoft Excel
# Enter the ''=mdLicense()'' function in any cell and confirm the ''License status'' field now reports ''LICENSE_OK''
# Enter the ''=mdLicense()'' function in any cell and confirm the ''License status'' field now reports ''LICENSE_OK''
# (Optional) Copy the ''mdModels2.lic'' file to the SysCAD License folder (e.g. ''C:\SysCAD139\License'') to enable SysCAD simulation


Alternatively, the Site Code character string may be obtained from the SysCAD application, via the About tab of an Access window associated with a Met Dynamics Integrated Library unit model.
Alternatively, the ''Site code'' character string may be obtained from the SysCAD application ''General Message Log'' or unit model Access window ''About'' tab, as described in the [[Installation and Licensing#Step Two (Optional): SysCAD installation|SysCAD installation]] section above.
 
Please contact [mailto:support@metdynamics.com.au support@metdynamics.com.au] if any step of the licensing procedure fails.


=== Trial license ===
=== Trial license ===
Line 80: Line 96:
Expired client or trial licenses limit software functionality in the following ways:
Expired client or trial licenses limit software functionality in the following ways:
* '''Excel''' functions cease to operate and return the ''#License error'' message in place of results
* '''Excel''' functions cease to operate and return the ''#License error'' message in place of results
* '''SysCAD''' projects will continue to load and unit models may be inspected. However, no new Met Dynamics unit models may be added to the project and the project will not Solve/Run
* '''SysCAD''' projects will continue to load and unit models may be inspected. However, the project will not Solve/Run if the ''On'' field of any Met Dynamics unit model in the project is checked.


== Uninstallation ==
== Uninstallation ==
Line 90: Line 106:
# Select ''File...Options...Add-Ins''
# Select ''File...Options...Add-Ins''
# Ensure ''Manage'' is set to ''Excel Add-Ins'' and click ''Go''
# Ensure ''Manage'' is set to ''Excel Add-Ins'' and click ''Go''
# Unselect the ''mdModels2.xll'' or ''mdModels2_32.xll'' checkbox and choose ''OK''
# Unselect the ''{{Name (Text, mdModels2, Excel, 64)}}'' or ''{{Name (Text, mdModels2, Excel, 32)}}'' checkbox and choose ''OK''
# Close Microsoft Excel
# Close Microsoft Excel
# Delete folder ''C:\mdModels2'' and all contents
# Delete the installation folder, e.g. ''C:\mdModels2'', and all contents
# Return to ''Excel Add-Ins'' via steps 1 - 3
# Return to ''Excel Add-Ins'' via steps 1 - 3
# Click on ''mdModels2'' or ''mdModels2_32.xll'' and select ''OK'' when prompted to "Delete from list"
# Click on ''mdModels2'' or ''{{Name (Text, mdModels2, Excel, 32)}}'' and select ''OK'' when prompted to "Delete from list"
# Close Microsoft Excel
# Close Microsoft Excel


=== SysCAD uninstallation ===
=== SysCAD uninstallation ===
While the SysCAD application is closed:
While the SysCAD application is closed:
# Delete the ''ScdMD.dll'' file from the SysCAD ''bin'' folder (e.g. ''C:\SysCAD139\bin'')
# Delete the ''{{Name (Text, mdModels2, SysCAD, DLL)|ext=1}}'' file from the SysCAD ''bin'' folder (e.g. ''C:\SysCAD139\bin'')
# Delete the ''mdModels2.lic'' file from the SysCAD ''License'' folder (e.g. ''C:\SysCAD139\License'')
 
'''Note''': SysCAD projects that include models from the {{Name (Text, mdModels2, SysCAD)}} will no longer load if the ''{{Name (Text, mdModels2, SysCAD, DLL)|ext=1}}'' file is removed.
 
== Further support ==


'''Note''': SysCAD projects that include models from the Met Dynamics Integrated Library will no longer load if the ''ScdMD.dll'' file is removed.
If any step of the installation or licensing procedures fails, please contact [mailto:support@metdynamics.com.au support@metdynamics.com.au] for assistance.

Revision as of 06:42, 10 February 2023

Introduction

This article describes the procedures for installing and licensing Met Dynamics software on client PCs.

Installation

Met Dynamics software may be installed by following the procedures provided in this section:

  • Manual installation steps are provided in lieu of an installer program, which may be restricted in some security environments.
  • Some basic knowledge of file manipulation in Microsoft Windows is required to complete the installation.

System requirements

The following hardware, operating system and software installations (and licenses) are required in order to use Met Dynamics software:

  • Intel or AMD CPU with AVX2 support (circa 2013+)
  • Microsoft Windows 10 or 11
  • Microsoft Office 365 (Excel)
  • (Optional) SysCAD 9.3 Build 139.32355

Administrator rights are not required to install or use Met Dynamics software.

Distribution package

Met Dynamics software is distributed as a zip archive file. The zip archive contains versions of the software for all available interfaces (e.g. Excel, SysCAD).

To obtain the latest distribution, please contact support@metdynamics.com.au

Step One: Excel installation

Met Dynamics software may be installed for Microsoft Excel by undertaking the following steps:

  1. Unzip the contents of mdModels2.zip into C:\mdModels2 (recommended) or your preferred folder
  2. Start Microsoft Excel
  3. Identify your Excel installation architecture (32 or 64 bit), File…Account…About Excel
  4. Select File...Options...Add-Ins
  5. Ensure Manage is set to Excel Add-Ins and click Go
  6. Select Browse and navigate to your installation path (e.g. C:\mdModels2)
  7. For 64 bit versions of Excel (default Office install), select the file mdModels2.xll and choose Ok
  8. For 32 bit versions of Excel, select the file mdModels2_32.xll and choose Ok
  9. Return to the Excel worksheet window
  10. Enter the formula =mdLicense() in any cell and press Enter
  11. Confirm the software license information is displayed and the License status field is LICENSE_OK on the About tab or General Message Log
  12. If the software is not licensed, please proceed to the Licensing section below for instructions on obtaining a license.

Step Two (Optional): SysCAD installation

It is recommended that Met Dynamics software is installed for Microsoft Excel and the license is confirmed before installing the SysCAD interface.

To install the Met Dynamics SysCAD Integrated Library, please use Windows Explorer or a command prompt to undertake the following steps:

  1. Copy the MetDynamics.dll file from your Met Dynamics software installation path (e.g. C:\mdModels2) to the SysCAD bin folder (e.g. C:\SysCAD139\bin)
  2. Start SysCAD and open an existing project that utilises the Met Dynamics SysCAD Integrated Library, or create a new configuration file and project as described in Getting started
  3. View the General Message Log in the SysCAD Message Window and locate the text section beginning with "Met Dynamics SysCAD Integrated Library..."
  4. Confirm the software license information is displayed and the License status field is LICENSE_OK
  5. If the software is not licensed and the License location field does not point to a valid license file:
    1. Open the SysCAD Access window for an existing Met Dynamics unit model, or insert a new model if none are present
    2. Click on the About tab
    3. Click the Browse button and use the file explorer to select a valid license file
    4. Confirm the software license information is displayed and the License status field is LICENSE_OK
  6. If the General Message Log reports "WARNING: SysCAD Runtime license or /rt command line argument required for Met Dynamics 'SysCAD Runtime' license level", then the Met Dynamics software is licensed for runtime use only. Please obtain a runtime license for SysCAD or start the SysCAD application in runtime mode
  7. If the software is otherwise not licensed, please proceed to the Licensing section below for instructions on obtaining a license.

Note: The Met Dynamics SysCAD Integrated Library is compiled against a specific SysCAD Build version, as noted in the Revision History. As such, SysCAD projects utilising Met Dynamics models may cease to load if the SysCAD version is upgraded without the corresponding version of MetDynamics.dll.

Licensing

Licenses to use Met Dynamics software are provided on a 'per seat' basis.

A granted license is locked to the unique hardware identifier of an individual client PC.

Obtaining a license

The steps below outline the procedure for obtaining a license for Met Dynamics software:

  1. Install Met Dynamics software for Microsoft Excel, as described above
  2. Start Microsoft Excel
  3. Enter the formula =mdLicense() in any cell and press Enter
  4. Copy the string of characters displayed next to the Site Code field to the Windows clipboard
  5. Close Microsoft Excel
  6. Paste the Site Code character string into the body of a new email message
  7. Include your contact details and a message requesting a license issue in the email
  8. Send the email to the Met Dynamics Support team at support@metdynamics.com.au
  9. After the license request has been received, Met Dynamics will generate a license file and return it to the sender's email address
  10. Place a copy of the returned license file (e.g. mdModels2.lic) in the mdModels2 installation path (e.g. C:\mdModels2)
  11. Start Microsoft Excel
  12. Enter the =mdLicense() function in any cell and confirm the License status field now reports LICENSE_OK

Alternatively, the Site code character string may be obtained from the SysCAD application General Message Log or unit model Access window About tab, as described in the SysCAD installation section above.

Trial license

A Trial License for Met Dynamics software is available upon request:

  • A 30 day trial period is typically offered
  • Trial licenses are not locked to client PC hardware identifiers, and software functionality is not in any way restricted during the trial period
  • The software will cease to function after the expiration of the trial period

Please contact support@metdynamics.com.au to request a trial license.

Expired licenses

Expired client or trial licenses limit software functionality in the following ways:

  • Excel functions cease to operate and return the #License error message in place of results
  • SysCAD projects will continue to load and unit models may be inspected. However, the project will not Solve/Run if the On field of any Met Dynamics unit model in the project is checked.

Uninstallation

Met Dynamics software may be removed from your system by following the instructions below.

Excel uninstallation

  1. Start Microsoft Excel
  2. Select File...Options...Add-Ins
  3. Ensure Manage is set to Excel Add-Ins and click Go
  4. Unselect the mdModels2.xll or mdModels2_32.xll checkbox and choose OK
  5. Close Microsoft Excel
  6. Delete the installation folder, e.g. C:\mdModels2, and all contents
  7. Return to Excel Add-Ins via steps 1 - 3
  8. Click on mdModels2 or mdModels2_32.xll and select OK when prompted to "Delete from list"
  9. Close Microsoft Excel

SysCAD uninstallation

While the SysCAD application is closed:

  1. Delete the MetDynamics.dll file from the SysCAD bin folder (e.g. C:\SysCAD139\bin)

Note: SysCAD projects that include models from the Met Dynamics SysCAD Integrated Library will no longer load if the MetDynamics.dll file is removed.

Further support

If any step of the installation or licensing procedures fails, please contact support@metdynamics.com.au for assistance.

Retrieved from "https://wiki.metdynamics.com.au/index.php?title=Installation_and_Licensing&oldid=725"