NAG dco/c++ version 4.2

DGW6I04XNL - Licence Managed

Microsoft Windows, 64-bit, Visual Studio 2019 or later

Installer's Note



Contents


1. Introduction

This document provides implementation-specific information relating to the installation of dco/c++ gold.

This version of dco/c++ is suitable for Visual Studio versions VS2019 and newer.

2. Implementation Provided

2.1. Applicability

This implementation is considered suitable for operation on the computer systems detailed below:

hardware:          Intel 64 systems and compatible (including AMD64)
operating system:  Microsoft Windows 64-bit editions
C++ compiler:      Microsoft 64-bit C/C++ compiler
                   (VS version >= VS2019)

2.2. Supplementary Information

Please check the following URL:

https://www.nag.com/doc/inun/dg04/w6ixnl/supplementary.html

for details of any new information related to the applicability or usage of this implementation. Details of any other systems on which it has been tested may also be found on this page.

3. Distribution

The software is available to download from the NAG website.

3.1. Contents

The following shows the folder and file organization of the implementation materials after installation:
                 |- batch -|- envvars.bat (setting the environment variables)
                 |
                 |- bin -|- (licence management tools, and compiler run-time DLLs)
                 |
                 |- case_studies -|- (more sophisticated examples from the
                 |                |   user guide, along with the corresponding CMakeLists.txt)
                 |
                 |- cmake -|- (auxiliary files required for building and testing with CMake)
                 |
                 |- doc   -|- in.html  (Installer's Note - this document)
                 |         |- userguide.pdf (User Guide as pdf)
                 |         |- nag_tsandcs.txt (terms and conditions)
                 |         |- licence -|- *  (licence management documentation)
dgw6i04xnl_v423 -|
                 |
                 |- examples -|- (directories containing various example programs
                 |            |   from the user guide, along with the CMakeLists.txt)
                 |
                 |- include -|- *.hpp  (C++ header files)
                 |
                 |- lib -|- (libraries and compiler run-time libraries)
                 |
                 |- CMakeLists.txt -|- (used for building and testing)  

4. Installation on Windows

4.1. Normal Installation

Assuming you have downloaded the dco/c++ installer from our website, run the self-extracting executable to start installation.

By default, the dco/c++ materials are installed in

  C:\Program Files\NAG\DC42\dgw6i04xnl_v423
or the equivalent for your locale.

The environment variables PATH, LIB and INCLUDE are used by the Microsoft C++ compiler to locate run-time and compile-time directories used by dco/c++.

These environment variables can be updated during installation of dco/c++ with permission of the installer. Alternatively, you may set the variables on a temporary basis in a Visual Studio Command Prompt by executing the file dgw6i04xnl_v423\batch\envvars.bat. Note that CMake picks up the right paths automatically when find_package(NAG_dco_cpp) is used.

This software is provided with an uninstallation facility via the Windows Control Panel.

4.2. Silent Installation

This product may be installed in silent (unattended) mode by running
  dgw6i04xnl_v423_setup.exe /silent
or
  dgw6i04xnl_v423_setup.exe /verysilent
from a command prompt. With the first version, the user sees a progress bar on the screen as the installation occurs, whereas with the second, nothing is displayed. The files will be installed to the default location, unless the default installation location gets overridden by using the /dir switch, e.g. /dir="C:\my folder".

4.3. Licence Management

The use of this product is controlled by the Kusari licence management system. This release of dco/c++ uses version 2.2-88 of Kusari.

In order to enable the software, NAG will issue you with a licence key. The licence key is contained in a text file consisting of details of the software that will be enabled. For evaluation purposes a trial licence may be used. Before obtaining a full licence you need to know the Kusari hostid of the system on which you intend to use this product. How to do this is described below.

The easiest way to request a licence key is to use the Kusari Installer GUI described in the next section. Once you have a key, the same GUI can be used to install it.

The information below covers the most common requirements. For more complex licensing situations, please see the Kusari documentation (the files k-using-win.pdf and k-install-win.pdf in the dgw6i04xnl_v423\doc\licence folder). See also the Kusari FAQ.

4.3.1. The Kusari Installer licence key request and key installation program

The recommended way to request a licence key is to use the Kusari Installer GUI program provided. This will help you to build a standard message requesting either a trial key or a full key which can be pasted into an email to the NAG Technical Support Service. This message will include the Kusari hostid.

To request a licence key, run the Kusari Installer program, which may be accessed via the Start Menu or All apps shortcut NAG DGW6I04XNL Licence, Request or Install.

Click on the Request New Licence button to bring up the New Licence Request form. Fill in your details and click on Generate Licence Request, then paste the generated information into your email client and send it to the NAG address given at the top of the generated information.

The NAG support team will send you the Kusari licence key by email.

A short term (demonstration or trial) licence key contains one or more lines like the following:

  DGW6I04XN TRIAL <EXPIRY_DATE> "EMnxidA3oeoj0F1Yvi5ibxPjB7"
Specifically, it has a line containing the word TRIAL. Longer term licence keys must be locked to a specific computer, i.e. they will enable the software on one computer only. These licence keys typically include the word NODE or FULL instead of the word TRIAL above and may contain extra fields.

Once you have obtained one of the above licence keys, the Kusari Installer program may be used to install the key in the Windows Registry. Paste the key into the edit box on the main Kusari Installer dialog and then click on the Install Licence Key button to install it.

4.3.2. Command line licence key request

If for any reason it is impractical to use the GUI, the command line program khostid may be run instead. The output of this command should be sent to the NAG Technical Support Service with your details, your organisation details and your NAG customer reference number (if known).

The khostid command may be found in the dgw6i04xnl_v423\bin folder.

4.3.3. Command line installation of the licence key in the registry

If not using the GUI, the klreg program may be executed from a Command Prompt to install a key in the registry. This program may be found in the dgw6i04xnl_v423\bin folder. First put the licence key in a file, say licence.dat. If you have administrator privileges you can install the key for all users,
  klreg DGW6I04XN licence.dat
Otherwise the key can be installed for the current user,
  klreg /current_user DGW6I04XN licence.dat

4.3.4. Installing the licence key in a file

You are recommended to install the licence key in the registry as described above. If this is not suitable an alternative method is to put the licence key into a file accessible from the machine for which the software is licenced and set the environment variable NAG_KUSARI_FILE to the full pathname of the licence file.

The environment variable may be set from the Control Panel.

4.3.5. USB key licences

Simply insert the USB key in any spare USB socket on the machine on which you wish to run this product.

4.3.6. Testing the licence

Any of the example programs distributed with dco/c++ (see Section 5 below) may be used to check accessibility and licensing. For more details on how to install the licence, please see the respective subdirectory after installation.

5. Example Programs

Access to the dco/c++ materials can be checked by running a few example programs following the advice given below. Detailed documentation on dco/c++ and examples is located in the User Guide which can be found in the dgw6i04xnl_v423\doc directory.

More sophisticated examples (case studies) are located in folders

5.1. Running from the Command Line

5.2. Generate a Visual Studio Solution

A Visual Studio Solution containing the example programs can be generated using CMake if an appropriate generator is chosen. For example,
        cmake -S "C:\Program Files\NAG\DC42\dgw6i04xnl_v423" -G "Visual Studio 15 2017"
   
will create dco_cpp.sln in the current directory. See here for a list of available generators.

dco_cpp.sln can be opened with Visual Studio 2017 to load the solution. Each example and each case study has its own project and can be built and run individually. Additionally, the project "ALL_BUILD" can be used to build all examples and case studies at once. Then, building the "RUN_TESTS" project will execute all examples and case studies. Please note that "ALL_BUILD" can not be used to run the executables.

6. Contact NAG

To get maximum benefit of dco/c++ please contact the NAG Technical Support Service. We would be delighted to receive your feedback on NAG's products and services.