Skip to content

MALES-project/SpeckleCn2Profiler

Repository files navigation

Python application test Coverage Documentation Status PyPI - Python Version PyPI FAIR checklist badge DOI RSD status

MALES banner MALES banner

SpeckleCn2Profiler:

Improving Satellite Communications with SCIDAR and Machine Learning

Graphical abstract

Overview

Optical satellite communications is a growing research field with bright commercial perspectives. One of the challenges for optical links through the atmosphere is turbulence, which is also apparent by the twinkling of stars. The reduction of the quality can be calculated, but it needs the turbulence strength over the path the optical beam is running. Estimation of the turbulence strength is done at astronomic sites, but not at rural or urban sites. To be able to do this, a simple instrument is required. We want to propose to use a single star Scintillation Detection and Ranging (SCIDAR), which is an instrument that can estimate the turbulence strength, based on the observation of a single star. In this setting, reliable signal processing of the received images of the star is most challenging. We propose to solve this by Machine Learning.

Repository Contents

This repository contains the workflow to implement and train machine learning models for turbulence strength estimation from SCIDAR data. Extensive Documentation is available to explain the methodology, algorithms used, and guidelines for using the code.

Getting Started

To get started with the project, follow these steps:

  • Prerequisites: In order to correctly install speckcn2 you need python3.9 or higher. If you don't have it installed, you can download it from the official website. You will also need the header files that are required to compile Python extensions and are contained in python3-dev. On Ubuntu, you can install them with:

    apt-get install python3-dev
  • Install the package:

    python -m pip install speckcn2
  • Or: Clone the repository:

    git clone https://github.com/MALES-project/SpeckleCn2Profiler.git
    cd SpeckleCn2Profiler
    git submodule init
    git submodule update
    pip install .

Usage

To use the package, you run the commands such as:

python <mycode.py> <path_to_config.yml>

where <mycode.py> is the name of the script that trains/uses the speckcn2 model and <path_to_config.yml> is the path to the configuration file.

Here you can find a typical example run and an explanation of all the main configuration parameter. In the example submodule you can find multiple examples and multiple configuration to take inspiration from.

What can we predict?

A machine learning model trained using speckcn2 can predict:

1. Instantaneous turbulence strength

prediction Given a speckle pattern, the model can predict the instantaneous turbulence strength and also provide an uncertainty estimate if more patterns are available.

2. Parameters estimation

The model can also estimate important parameters that are useful for the analysis of the speckle pattern. At the moment we support:

  • Fried parameter r0
  • Isoplanatic angle θ0
  • Rytov Index σ

We also provide histograms of the estimated parameters and the error of the estimation.

Contribution Guidelines

We welcome contributions to improve and expand the capabilities of this project. If you have ideas, bug fixes, or enhancements, please submit a pull request. Check out our Contributing Guidelines to get started with development.

Generative-AI Disclaimer

Parts of the code have been generated and/or refined using GitHub Copilot. All AI-output has been verified for correctness, accuracy and completeness, revised where needed, and approved by the author(s).

How to cite

Please consider citing this software that is published in Zenodo under the DOI 10.5281/zenodo.11447920.

License

This project is licensed under the Apache 2.0 License - see the LICENSE file for details.