#telescope #astronomy

gmt_dos-actors

Giant Magellan Telescope Dynamic Optical Simulation Actor Model

16 stable releases (6 major)

9.0.0 Sep 14, 2023
8.0.1 Sep 12, 2023
7.1.2 Aug 27, 2023
7.1.1 Jul 25, 2023
3.0.1 Sep 20, 2022

#61 in Science

Download history 109/week @ 2023-06-03 80/week @ 2023-06-10 164/week @ 2023-06-17 118/week @ 2023-06-24 150/week @ 2023-07-01 223/week @ 2023-07-08 136/week @ 2023-07-15 153/week @ 2023-07-22 53/week @ 2023-07-29 98/week @ 2023-08-05 115/week @ 2023-08-12 50/week @ 2023-08-19 105/week @ 2023-08-26 120/week @ 2023-09-02 254/week @ 2023-09-09 89/week @ 2023-09-16

568 downloads per month
Used in 15 crates (10 directly)

MIT license

2MB
2.5K SLoC

gmt_dos-actors

Crates.io Documentation

gmt_dos-actors is an implementation of the actor model applied to integrated modeling for the Giant Magellan Telescope.

Features

  • Asynchronous actors model
  • Channel based data exchange between actors
  • channels validation at compile time
  • formal interface definition (trait based) between actors and actor clients
  • scripting macro to reduce boilerplate clutter

lib.rs:

GMT Dynamic Optics Simulation Actors

The GMT DOS [Actor]s are the building blocks of the GMT DOS integrated model. Each [Actor] has 3 properties:

  1. input objects
  2. output objects
  3. client

Input/Outputs

input objects are a collection of inputs and output objects are a collection of outputs. An actor must have at least either 1 input or 1 output. A pair of input/output is linked with a channel where the input is the receiver and the output is the sender. The same output may be linked to several inputs. channels are used to synchronize the [Actor]s.

Each [Actor] performs the same task, within an infinite loop, consisting of 3 operations:

  1. receiving the inputs if any
  2. updating the client state
  3. sending the outputs if any

The loop exits when one of the following error happens: ActorError::NoData, ActorError::DropSend, ActorError::DropRecv.

Sampling rates

All the inputs of an [Actor] are collected are the same rate NI, and all the outputs are distributed at the same rate NO, however both inputs and outputs rates may be different. The inputs rate NI is inherited from the rate NO of outputs that the data is collected from i.e. (next actor)::NI=(current actor)::NO.

The rates NI or NO are defined as the ratio between the simulation sampling frequency [Hz] and the actor inputs or outputs sampling frequency [Hz], it must be an integer ≥ 1. If NI>NO, outputs are upsampled with a simple sample-and-hold for NI/NO samples. If NO>NI, outputs are decimated by a factor NO/NI

For a 1000Hz simulation sampling frequency, the following table gives some examples of inputs/outputs sampling frequencies and rate:

Inputs [Hz] Ouputs [Hz] NI NO Upsampling Decimation
1000 1000 1 1 - 1
1000 100 1 10 - 10
100 1000 10 1 10 -
500 100 2 10 - 5
100 500 10 2 5 -

Client

A client must be assigned to an [Actor] and the client must implement some of the following traits:

  • write if the actor has some outputs,
  • read if the actor has some inputs,
  • update, this trait must always be implemented (but the default empty implementation is acceptable)

Model

An integrated model is build as follows:

  1. select and instanciate the [clients]
  2. assign [clients] to [actor]s
  3. add outputs to the [Actor]s and connect them to inputs of other [Actor]s
  4. build a [mod@model]
  5. Check, run and wait for the Model completion

For more detailed explanations and examples, check the [actor] and [mod@model] modules.

Features

Dependencies

~5–17MB
~176K SLoC