Click or drag to resize

What's included in the Software Developer Kit

The following components are included in the SDK:

Assemblies

Assemblies needed to develop applications that target either the Cluster Scheduler or Embedded Scheduler:

  • AGI.Parallel.Client.dll
  • AGI.Parallel.Infrastructure.dll

In addition to the above assemblies, the following assemblies are needed by the Embedded Scheduler:

  • AGI.Parallel.EmbeddedClient.dll
  • AGI.Parallel.Agent.dll
  • AGI.Parallel.Shared.dll
  • AGI.Parallel.Host.exe
  • AGI.Parallel.Host.exe.config
  • AGI.Parallel.Host_WkGc.exe
  • AGI.Parallel.Host_WkGc.exe.config
  • AGI.Parallel.Host_x86.exe
  • AGI.Parallel.Host_x86.exe.config
  • AGI.Parallel.Host_WkGc_x86.exe
  • AGI.Parallel.Host_WkGc_x86.exe.config
  • NLog.dll

The Embedded Scheduler is not yet supported for .NET 5.

Documentation

The API documentation (this document) and Visual Studio Intellisense XML.

Diagnostic Applications

Applications for monitoring and debugging the cluster job scheduler:

  • Management Console - An application that queries and prints the state of the cluster. For instance, you can print the list of tasks and agents in the coordinator.
Note Note

Running the Management Console requires an installation of the .NET 5.0 runtime. A copy of the runtime is included with the STK Parallel Computing Server install at [path to STK Parallel Computing Server install]\Server\Prerequirements\DotNet.Core\v5.0.13.

Tip Tip

Run AGI.Parallel.ManagementConsole.exe in a cmd prompt to see the usage instructions.

Sample Applications

The following full applications demonstrating different uses of the API are located in the Examples folder. Although the included solutions were saved with Visual Studio 2012, it is safe to open and migrate them with a later version of Visual Studio.

  • AddExample - Simple example that adds two numbers together.
  • EmbeddedSchedulerTemplate - Template Visual Studio project that already sets up the embedded job scheduler.
  • Mandelbrot - An interactive example that renders the Mandelbrot fractal in parallel.
  • PiCalculator - Computes arbitrary large digit instances of PI.
  • PingPong - Demonstrates a simple use of message passing.
  • DichotomicSearch - Example that uses sub tasks to solve a divide and conquer algorithm.

Except for the EmbeddedSchedulerTemplate, all of the sample applications listed above are also available in versions built using .NET 5.0 in Visual Studio 2019.

In addition, the following are examples of how to use this product with other AGI products. These examples are located in the WorkingWithAGIProducts directory. The other AGI products must be installed and licensed separately.

  • WhereIsMySatelliteServer - Example of how to use this product with STK in a simple web service.
  • WhereIsMySatelliteClient - Various client applications that can consume the web service provided at WhereIsMySatelliteServer.
  • AirlineRouteAnalyzer - Example of how to use STK Components with this product.
Tip Tip

For more complete samples, take a look at the How To.

What is NOT included in the SDK

The Coordinator and Agent are bundled in the Install, which is distributed separately. Make sure you have acquired the Install if you plan to develop applications targeting the cluster job scheduler.

STK Parallel Computing Server 2.9 API for .NET