1150 simple antenna #1229

OliverHasle · 2026-01-13T03:39:31Z

Tickets addressed: bsk-000
Review: By commit
Merge strategy: Merge (no squash)

Description

The simpleAntenna module allows attaching a simplified antenna model to a spacecraft or to a ground location. This forms the basis for a link-budget which shall be implemented on a later stage.

Verification

Unit tests for the modules simpleAntenna and antennaPower

Documentation

Documentation for both modules has been added to the basilisk framework

Future work

Implementation of the module "link budget"

schaubh

Thanks, very nice work overall. Some small things to look at.

Also, you don't have release notes added. Please add a brief statement to docs/source/Support/bskReleaseNotes.rst saying this branch adds :ref:simpleAntenna and :ref:antennaPower modules.

schaubh · 2026-01-19T20:47:38Z

src/architecture/msgPayloadDefC/AntennaLogMsgPayload.h

+/*! antenna state message definition */
+typedef struct {
+    char        antennaName[20];                       //!< --      Antenna Name
+    char        ModelTag[20];                          //!< --      Model tag


why do we have ModelTag in the message?

The linkBudget module is going to have two modules: "simpleAntenna" attached.
To distinguish one module: "simpleAntenna" from the other one we either need the ModelTag or the antennaName.

I was not aware of the ModelTag until you (@schaubh ) made me aware of this.

What do you think is better, keeping ModelTag or antennaName for this purpose (or both?)

I think antennaName name here is clearer. Thanks for the explanation.

I "re-introduced" antennaName and removed modelTag. antennaName is a mandatory value (BSK_ERROR) if not set.
The thought behind this is, that someone might want to have >1 antenna on a spacecraft and therefore must be able to keep them appart.

I have done the related changes in the following files:

simpleAntenna.cpp

simpleAntenna.h

AntennaLogMsgPayload.h

Leaving this conversation unresolved. If you are happy with the change feel free to 'resolve conversation'

src/architecture/msgPayloadDefC/AntennaLogMsgPayload.h

src/architecture/msgPayloadDefC/AntennaStateMsgPayload.h

src/simulation/communication/simpleAntenna/simpleAntenna.h

src/architecture/utilities/haslamBackgroundRadiation.h

schaubh · 2026-01-19T21:46:05Z

src/utilities/supportDataTools/registrySnippet.py

-    "supportData/LocalGravData/VESTA20H.txt": "md5:f9ec4308ea7049656f64e64d6019d570",
-    "supportData/LocalGravData/eros007790.tab": "md5:5bdf62cee6c7069ea547cca6ed7c724f",
-    "supportData/MagneticField/WMM.COF": "md5:8caac788545d3a32d55faba8aa87c93b",
+    "supportData/AlbedoData/Earth_ALB_2018_CERES_All_10x10.csv": "md5:a448e61eadaebc76b4a03d612b1d6bbf",


@ReeceHumphreys , does this look correct to you? Thanks for the quick sanity check.

I think there may be an issue with that @ReeceHumphreys. When I run the bskLargeData command. It says:
`...
Downloading supportData/LocalGravData/VESTA20H.txt
Downloading supportData/LocalGravData/eros007790.tab
Downloading supportData/MagneticField/WMM.COF
Downloading supportData/SkyBrightnessData/haslam408_dsds_Remazeilles2014.fits
Fetching data files: 100%|█| 50/50 [00:00<00:00, 290.09file/s]

Completed pre-fetch.
Fetched 50 / 50 files.
All supportData files fetched successfully!
(.venv) dahu1128@UCB-GWYQFGP29F basilisk % cd supportData
(.venv) dahu1128@UCB-GWYQFGP29F supportData % ls
AlbedoData AtmosphereData DentonGEO EphemerisData LocalGravData MagneticField
`

The folder "SkyBrightnessData" does not get created and the Haslam Map is actually not being downloaded...

The hashmap should not be getting updated at all since this file is being fetched from an external source.

The changes to this seem to be related to the windows file endings stuff we were dealing with last week. I might have to send out instructions to anyone on windows to run on their computers so this isn't an issue.

I can investigate more later in the week.

I just checked and the file downloaded for me checking out this PR, you may not have been looking in the right place. Pooch caches the files itself in its own caches:

~/Developer/AVS/basilisk 1150-simpleAntenna* ⇣⇡ ❯ cd ~/Library/Caches/bsk_support_data ~/Library/Caches/bsk_support_data ❯ ls supportData ~/Library/Caches/bsk_support_data ❯ cd supportData ~/Library/Caches/bsk_support_data/supportData ❯ l total 0 drwxr-xr-x 9 reece staff 288B Jan 20 15:02 . drwxr-xr-x 3 reece staff 96B Jan 20 15:02 .. drwxr-xr-x 20 reece staff 640B Nov 30 16:30 AlbedoData drwxr-xr-x 11 reece staff 352B Nov 30 16:30 AtmosphereData drwxr-xr-x 10 reece staff 320B Nov 30 16:30 DentonGEO drwxr-xr-x 10 reece staff 320B Jan 2 02:03 EphemerisData drwxr-xr-x 7 reece staff 224B Nov 30 16:30 LocalGravData drwxr-xr-x 3 reece staff 96B Nov 30 16:30 MagneticField drwxr-xr-x 3 reece staff 96B Jan 20 15:02 SkyBrightnessData ~/Library/Caches/bsk_support_data/supportData ❯ cd SkyBrightnessData ~/Library/Caches/bsk_support_data/supportData/SkyBrightnessData ❯ ls haslam408_dsds_Remazeilles2014.fits

schaubh · 2026-01-19T21:46:47Z

src/utilities/supportDataTools/dataFetcher.py

    "supportData/EphemerisData/de-403-masses.tpc": "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/de-403-masses.tpc",
    "supportData/EphemerisData/hst_edited.bsp": "https://naif.jpl.nasa.gov/pub/naif/HST/kernels/spk/hst_edited.bsp",
    "supportData/EphemerisData/nh_pred_od077.bsp": "https://naif.jpl.nasa.gov/pub/naif/pds/data/nh-j_p_ss-spice-6-v1.0/nhsp_1000/data/spk/nh_pred_od077.bsp",
+    "supportData/SkyBrightnessData/haslam408_dsds_Remazeilles2014.fits": "https://lambda.gsfc.nasa.gov/data/foregrounds/haslam_2014/haslam408_dsds_Remazeilles2014.fits",


I ran all the tests, but this data never got downloaded to my computer. Where is this data used?

It seems there are a few Unit tests missing.
I will look into this and add them myself or coordinate with Daniel.

Don't have too much time today to investigate this in detail but I see the skyTemperature408MHz is never used in this PR. If a test does not use this data then the file will never be downloaded since everything is on demand now.

There would need to be this in a test for it to automatically be pulled.

some_variable = get_path(DataFile.SkyBrightnessData.skyTemperature408MHz)

The haslam map is not tested (cheers to @dhutererprats)
please 'resolve conversation' if you are happy with this.

schaubh · 2026-01-19T21:48:02Z

src/architecture/utilities/brightnessTemperatureSolarSystem.hpp

@@ -0,0 +1,98 @@
+/*


the 1st line of the commit message is too long. GitHub uses the first line as the title. Please edit the commit message to have a shorter first line.

I have shortened the first line of all the commit messages.
Please let me know if there are still issues regarding this.

please 'resolve conversation' if this is good.

src/simulation/communication/simpleAntenna/simpleAntenna.rst

ReeceHumphreys · 2026-01-20T21:57:09Z

src/utilities/supportDataTools/registrySnippet.py

@@ -1,4 +1,4 @@
-# Auto-generated registry of support data files by make_registry.py
+# Auto-generated registry of support data files by makeRegistry.py


I find it weird that the hashes in this file have changed order. I may have made some minor tweaks makeRegistry and not committed the resulting registry. I'll look into it but this PR shouldn't need to to regenerate the registry since we are not versioning the data file ourselves.

This is working now.
From my side this can be closed.

ReeceHumphreys · 2026-01-20T22:01:07Z

src/utilities/supportDataTools/dataFetcher.py

    "supportData/EphemerisData/de-403-masses.tpc": "https://naif.jpl.nasa.gov/pub/naif/generic_kernels/pck/de-403-masses.tpc",
    "supportData/EphemerisData/hst_edited.bsp": "https://naif.jpl.nasa.gov/pub/naif/HST/kernels/spk/hst_edited.bsp",
    "supportData/EphemerisData/nh_pred_od077.bsp": "https://naif.jpl.nasa.gov/pub/naif/pds/data/nh-j_p_ss-spice-6-v1.0/nhsp_1000/data/spk/nh_pred_od077.bsp",
+    "supportData/SkyBrightnessData/haslam408_dsds_Remazeilles2014.fits": "https://lambda.gsfc.nasa.gov/data/foregrounds/haslam_2014/haslam408_dsds_Remazeilles2014.fits",


Don't have too much time today to investigate this in detail but I see the skyTemperature408MHz is never used in this PR. If a test does not use this data then the file will never be downloaded since everything is on demand now.

There would need to be this in a test for it to automatically be pulled.

some_variable = get_path(DataFile.SkyBrightnessData.skyTemperature408MHz)

OliverHasle · 2026-01-21T01:16:01Z

Further changes done since the review 1:

Added a "BETA" label to the simpleAntenna documentation.
Changes related to file download and file handling
Improvements to maintainability of 'test_simpleAntenna.py'
robustness improvements to haslam map handling

This commit contains the main (*.cpp), header (*.h) and swig (*.i) files for these modules. Further changes which have been done in this commit: - Introduction of the message: "AntennaStateMsgPayload.h" containing the antenna state (Off, Rx, Tx, RxTx) - Introduction of the message: "antennaLogMsgPayload.h" containing the antenna state (will be an input to link-budget calculations) - Introduction of an antenna type in: "_GeneralModuleFiles/AntennaDefinitions.h" - Update to the build system: "conanfile.py", "CMakeLists.txt" and "utilities/CMakeKLists.txt"

The following libraries were added: - brightnessTemperatureSolarSystem - haslamBackgroundRadiation. These libraries are used to estimate the sky brighness temperature seen by the antenna. Together with this library, the registrySnippet.py was updated (needed for the data downloaded in SupportData)

- Renaming v_AN to v_AN_N - Update to cpp and h code comments to improve documentation (remove rendering errors)

- Fixes related to hash generation - Haslam map file path

- Removal of not needed/outdated comments - Corrections to existing comments

OliverHasle · 2026-01-23T23:14:47Z

@schaubh This PR is ready for review again.

The commit '612778a' and newer is what has changed since the last review.
Besides addressing the comments made in the last review, the following has changed:
- Improvement of testing (haslam map case).
- Removed outdated comments
- Improved various existing comments (some were not rendered correctly in the documentation)
- Improved reading hand handling of the haslam map.
- the issues related to: PR Resolve registry issues for Windows and Caching #1238 / Enforce supportData line endings are always LF for text files #1231 / Update paths to supportDataTools instead of supportData #1224 were found and resolved in the respective PRs

OliverHasle self-assigned this Jan 13, 2026

OliverHasle requested a review from a team as a code owner January 13, 2026 03:39

OliverHasle linked an issue Jan 13, 2026 that may be closed by this pull request

create a new Module simpleAntenna #1171

Open

OliverHasle marked this pull request as draft January 13, 2026 03:39

OliverHasle added the enhancement New feature or request label Jan 13, 2026

OliverHasle added this to Basilisk Jan 13, 2026

OliverHasle moved this to 🏗 In progress in Basilisk Jan 13, 2026

OliverHasle requested a review from schaubh January 13, 2026 03:41

OliverHasle force-pushed the 1150-simpleAntenna branch 7 times, most recently from 16ade02 to 2d173c9 Compare January 14, 2026 20:18

OliverHasle marked this pull request as ready for review January 14, 2026 20:39

OliverHasle moved this from 🏗 In progress to 👀 In review in Basilisk Jan 15, 2026

schaubh requested changes Jan 19, 2026

View reviewed changes

OliverHasle force-pushed the 1150-simpleAntenna branch from 2d173c9 to db5e125 Compare January 19, 2026 21:56

OliverHasle marked this pull request as draft January 19, 2026 22:19

OliverHasle force-pushed the 1150-simpleAntenna branch 2 times, most recently from e43e002 to 13bcec7 Compare January 20, 2026 00:00

ReeceHumphreys reviewed Jan 20, 2026

View reviewed changes

ReeceHumphreys force-pushed the 1150-simpleAntenna branch from 10b7a01 to 4a85854 Compare January 20, 2026 22:31

ReeceHumphreys force-pushed the 1150-simpleAntenna branch 2 times, most recently from 954659e to 3453d7a Compare January 22, 2026 18:33

OliverHasle added 3 commits January 22, 2026 14:27

Introduction "simpleAntenna" & "antennaPower" documentation

f4923bc

Unit tests for the modules "simpleAntenna" and "antennaPower"

6bf1efe

OliverHasle force-pushed the 1150-simpleAntenna branch 5 times, most recently from ab50738 to d3dcf2e Compare January 23, 2026 22:25

OliverHasle added 6 commits January 23, 2026 15:28

Corrected spelling errors in the header

612778a

Renaming and update to documentation

6f81faf

- Renaming v_AN to v_AN_N - Update to cpp and h code comments to improve documentation (remove rendering errors)

Change from modelTag to antennaName

6075e77

Improvement of haslam map handling robustness

19511d2

change of shadowfactor to illuminationfactor

080ec0e

removal of unnecessary comment (unreachable)

94ec995

OliverHasle force-pushed the 1150-simpleAntenna branch 2 times, most recently from d55d3f0 to 2cf6cdc Compare January 23, 2026 22:59

OliverHasle and others added 9 commits January 23, 2026 16:01

Documentation udpates

d7d2552

Fixes related to datadownlaod and haslam map handling

d0e9340

- Fixes related to hash generation - Haslam map file path

Updates to comments:

4e765d1

- Removal of not needed/outdated comments - Corrections to existing comments

robustness improvement to simpleAntenna unit test

1c979d9

check if Haslam map is already initialized before initializing new one.

1326f38

make calculateTsky() a public function

8b53071

test issues with Unit_test

732f30c

read haslam map correctly and close fits file properly

76e08c8

assemble unit_test including Haslam-map cases

4233b54

OliverHasle force-pushed the 1150-simpleAntenna branch from 2cf6cdc to 4233b54 Compare January 23, 2026 23:02

OliverHasle marked this pull request as ready for review January 23, 2026 23:08

		@@ -1,4 +1,4 @@
		# Auto-generated registry of support data files by make_registry.py
		# Auto-generated registry of support data files by makeRegistry.py

1150 simple antenna #1229

Are you sure you want to change the base?

1150 simple antenna #1229

Uh oh!

Conversation

OliverHasle commented Jan 13, 2026

Description

Verification

Documentation

Future work

Uh oh!

schaubh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OliverHasle Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dhutererprats Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OliverHasle Jan 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

OliverHasle commented Jan 21, 2026

Uh oh!

OliverHasle commented Jan 23, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

OliverHasle Jan 20, 2026 •

edited

Loading

dhutererprats Jan 20, 2026 •

edited

Loading

OliverHasle Jan 20, 2026 •

edited

Loading