Overview of PGO documentation
Below you will find an overview of the various sources of information that will help you to use the PGO service, and to integrate it into your own DSO systems solution.
In general, introductionary material, tutorials, and API documentation may be found at the PGO web site. More technical information related to PGO development, the open-source code, and how to use it, may be found at github.
High level documentation
The high level PGO documentation is organized as follows:
- An “at a glance” overview is given at the PGO home page
- A more detailed introduction to the PGO, what it can do, and how it can be used, is given in the Introduction to the PGO.
- More detailed information is provided about the conceptual model, along with some simple how-to modelling examples.
- A simple web application is available to give some idea about how the PGO can be used. The functionality of this is explained in the web application user manual.
Technical documentation
On a more technical level, observe that the PGO can be accessed through two types of API: a .NET API for in-process integration, and a HTTP-based API for using the PGO as server. Both API’s give access to the same functionality for setting up one or several grid configuration problems, running the PGO algorithms, monitor the search progress, and retrieved the resulting grid configurations.
The following API documentation is given for the HTTP API:
The corresponding documentation for the .NET API is given in the code, see the Readme file on github.
Finally, the PGO github repository gives you access to the open source code, as well as more technical information about how to use it. If you do not wish to compile the code, the Readme in the same repository describes how you can download the PGO Docker image, instead.