Getting Started
This section will guide the users of the PDS software in giving the first steps after the installation of the PDS software.
The user will be able to start the software components with the WS simulation deployment. More details for each of the PDS components will be given in the user manual. Once installed the PDS RPMs, the PDS software and resources are located under /elt/pds directory.
PDS Configuration
The PDS includes the configuration for different deployments. This means separate configuration files located in different directories. The configuration for WS simulation deployment is located in two subdirectories:
/elt/pds/resource/nomad/sim
/elt/pds/resource/config/sim
Note
The WS simulation deplyment configuration is not a full copy of the PDS configuration. It reuses the PDS configuration and just redefine what is needed to run in simulation.
Starting/Stopping the PDS Software
The PDS uses Nomad (see here) to manage the life cycle of the SW components following the recommendation from the ELT Control project. We are also using Consul, a complementary package providing service discovery that allow us to use names instead of using hostname/IPs and port numbers.
The PDS SW includes the Nomad job configuration to start-up/shutdown the software components.
Startup/Shutdown Contents
The PDS WS comes with a predefined startup/shutdown script to start/stop all PDS software processes, 69 in total. The list of processes for the WS simulation deployment is here:
1 DDT broker instance
1 DCS instance (AQGC camera)
1 DCS instance (SHAPS camera)
1 DCS instance (Pyramid camera)
1 DCS instance (LISA WFS camera)
1 DCS instance (ZIRCAM IR CCD)
1 FCS instance (AQGC subsystem)
1 FCS instance (SHAO subsystem)
1 FCS instance (SHAPS subsystem)
1 FCS instance (CBR subsystem)
1 FCS instance (MAICAL subsystem)
1 FCS instance (Pyramide subsystem)
1 FCS instance (ZIRCAM subsystem)
1 FCF Simulator for device for each of the FCS instances
1 OCM instance
1 DPM instance
1 System Supervisor
The script shall be executed by the Sequencer.
The script contains three main parts:
Stop all processes
Start all processes
Move all processes to Operational state.
Executing Startup/Shutdown Script
Starting Sequencer GUI
In a terminal, type the following command to start the sequencer GUI.
> seqtool gui
Running the Startup Script
Once the Sequencer GUI is running. Load the startup script (/elt/pds/lib/python3.12/site-packages/pds/stoo/startup.py) by selecting the Load Script option. It is assumed that the software has been already built and installed.
To execute the script, just press the play icon at the top of the Sequencer GUI as it is shown in the next figure. At the end of the execution, all instrument jobs shall be running and the system should be in Operational state.
A quick way to verify is to check the status of the Supervisor.
> supClient `geturi syssup-req` GetStatus
Operational;Idle
After a successful execution of the startup script, the nomad web UI can be used to verify the status the nomad jobs. A total of 69 jobs shall be running.
> nomad ui
The Consul UI can be used to verify the services registered. In this case the number of services is greater because in some cases there are two services defined per each Job.
Note
As convention, we use <service>-req as the registered name in consul for the service request/reply port, e.g. fcs-req
As convention, we use <service>-pub as the registered name in consul for the service publish/subscribe port, e.g. fcs-pub
Validating the Software with an OB
The best way to validate if the software is running well is to run one of the calibration OBs that has been prepared. Please load the OB /elt/pds/resource/seq/tec/PDS_gen_cal_dark.json. This OB contains one acquisition and one calibration template.
To run the OB, just press the play icon at the top of the Sequencer GUI.
The resulting FITS files generated by DPM are located under $DATAROOT/dpm/result.
Congratulations that you reached the end of the general Getting Started section. Further instructions you may find in the PDS Software User Manual.