README

********************************************************
* ARIEL FGS HFS Repository, ARIEL-UVIE-PL-ML-001 1.3.2 *
********************************************************

This repository contains the HFS, the simulator SW used to simulate the
behaviour of the FGS IASW for the AOCS closed loop test.

Files:

    src/detector_features ........... Library for detector simulation (.c/.h)
    src/utilities ................... Utility functions used by HFS (.c/.h)
    src/fcu_algorithms .............. Implementation of IASW methods and algorithms (.c/.h)
    src/HFS_API ..................... Main simulator and interface (.cpp/.hpp)
    src/HFS_bus.mat ................. Simulink bus object definitions for HFS
    src/HFS.config.xml .............. Config file for the HFS
    src/Star_catalogue.csv .......... Catalogue containing the star data
    src/HFS_Wrapper.................. C++ side implementation of the Simulink wrapper
    matlab_model/HFS_Wrapper ........ Simulink implementation example using legacy code tools (.m)
    matlab_model/Example_model.slx .. Simulink example showing the bus usage
    test/HFSTest .................... Unit tests for the HFS library (.cpp/.hpp)
    test/example.cpp ................ Example script showing the function of the library
    Quaternion_Calulator.py ........ Python command-line tool for quaternion determination
    Star_Validation_Signals.xlsx .... Table containing target signals and validation values for stars
    matlab_model/Test_Cases/ ........ Simulink Test Benches used in functional verification
    create_hot_pixels.py ............ Python script to create hot pixels and the corresponding calibration file
    CHANGELOG
    README
    MANUAL
    Documents/ ...................... Applicable dokuments for the HFS



Dependencies:

  - tinyxml2 (2.6.2)
  - fftw3-devel (3.3.3)
  - openmpi-devel (1.10.7)
  - cppunit (optional, needed by unit tests)
  - clang (optional, needed for static checks)
  - doxygen (optional, needed by documenation)
  - plantuml (optional, needed by documentation)
  - python numpy (optional, needed by Quaternion_Calulator)
  - python pandas (optional, needed by Quaternion_Calulator)

Build Library on CentOs 7.9
  > make all -f Makefile_Centos

Run example:
  > make example -f Makefile_Centos
  > ./example.out

Build S-Function block example:
  Build library:
  > make all -f Makefile_Centos
  Run HFS_Wrapper.m in Matlab

Run Quaternion_Calulator:
  > python3 Quaternion_Calulator.py TARGET_STAR_ID

Run unit tests:
  > make scan -f Makefile_Centos

Run test cases:
  Build the HFS function block
  set the time solver of the block to Fixed-step with 0.125s step size
  Run the desired test case

  Note that the cases use the config file in the matlab model folder

The software provided here is ©University of Vienna.


GM 5th August, 2024