Version 2.0.0 by brunohcfaria · Pull Request #239 · Radio-Spectrum/SHARC

brunohcfaria · 2025-12-05T11:36:48Z

Summary

The updates include major refactoring, new features, bug fixes, documentation updates, and the removal of the campaign folder.

Highlights

Features & Enhancements

Added local coordinate system support and related geometry calculations.
Service grid exclusion zone implementation and tests.
Simulator geometry improvements, including spherical sampling from grid and readonly global properties.
Space station can now point toward arbitrary lat/lon/alt.
Added utility functions for elevation to off-axis angle transformations.
User-defined n_aggregate and n_drops in results aggregation.

Refactoring

Major refactor of geometry converter to coordinate system.
Cleaned up SimulatorGeometry, comments, and getters.
Refactored parameters for service grid and country polygon shrinking.
Deleted height parameter from station manager.

Bug Fixes & Hotfixes

Fixed simulator log facility setup and added CLI option for log streaming.
Fixed propagation terrestrial simple clutter loss call and plot figure units.
Fixed IMT MSS DC topology subsatellite_distance calculation and related unit errors.
Fixed exclusion zone missing docstring and other minor documentation issues.
Fixed station factory spectral mask parameter and simulation geometry unset variable.
Fixed p619 apparent elevation angles and ES altitude.

Documentation & Maintenance

Removed campaign folder and related documentation:
- Campaigns are now considered temporary and should be managed by users, not code owners.
- This improves maintainability and keeps the codebase focused.
Updated tests to check antenna sub-params and default values.
Updated and cleaned up various docstrings and comments.

Merges

Merged multiple feature, hotfix, and update branches into development.

Breaking Changes

The campaign folder has been removed. Users are now responsible for managing their own campaign files.

Motivation

The campaign folder was growing too large and hard to maintain.
Campaigns are temporary, while SHARC code is permanent.
This change clarifies code ownership and responsibility.

Additional Notes

Please review the new geometry and service grid features.
Ensure your workflow does not depend on the removed campaign folder.

…t,lon,alt

…alt)

…ng_at_latlon feat(station): single_space_station can now point toward arbitrary la…

was always defaulting to the station frequency.

…eters from Antennas S.672 and S.1528 parameters.

no None. * Defaulting all ParametersAntennaS1528 to None

Fix/s1528 default frequency

…lygon_by_km

…on_zone Feat/service grid exclusion zone

update: enhance n_aggregate flexibility in aggregate_results method

…er_to_coordinate_sys refactor: geometry converter is now coordinate system

fix: p619 apparent elevation angles

hotfix: p619 es alt

Copilot

Pull request overview

This PR represents version 2.0.0 of SHARC, implementing a major refactoring focused on geometry and coordinate system handling, along with significant feature additions, bug fixes, and the removal of the campaign folder.

Key Changes:

Major refactoring of geometry handling from GeometryConverter to CoordinateSystem with new SimulatorGeometry class
Implementation of local coordinate system support and service grid exclusion zones
Removal of campaign folder (now considered temporary and user-managed)
Multiple bug fixes including unit conversion errors and propagation model corrections

Reviewed changes

Copilot reviewed 126 out of 154 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
`sharc/topology/topology_imt_mss_dc.py`	Updated to use `CoordinateSystem` instead of `GeometryConverter`, fixed angle conversion bug
`sharc/topology/topology_factory.py`	Updated parameter naming from `geometry_converter` to `coordinate_system`
`sharc/topology/topology.py`	Added methods for local geometry support
`sharc/support/sharc_logger.py`	Refactored logging setup, replaced class-based approach with function, updated type hints
`sharc/support/sharc_geom.py`	Renamed `GeometryConverter` to `CoordinateSystem`, added angle transformation methods, renamed function
`sharc/support/geometry.py`	New file implementing `SimulatorGeometry` and `GlobalGeometry` classes with readonly properties
`sharc/station_manager.py`	Removed height parameter, integrated `SimulatorGeometry`, removed duplicate geometry methods
`sharc/station_factory.py`	Updated to use `CoordinateSystem` and `SimulatorGeometry` throughout
`sharc/station.py`	Replaced `height` with `z`, simplified `__ne__` method
`sharc/simulation_uplink.py`	Added `PropagationPath` support, refactored interference calculations
`sharc/simulation_downlink.py`	Added `PropagationPath` support, refactored SINR calculations
`sharc/simulation.py`	Updated geometry references, added helper method for results aggregation
`sharc/satellite/utils/sat_utils.py`	Added utility functions for elevation/off-axis angle conversions
`sharc/satellite/scripts/plot_orbits_single_color_3d.py`	Updated to use `CoordinateSystem`
`sharc/satellite/scripts/plot_globe.py`	Updated parameter naming to `coord_sys`
`sharc/satellite/scripts/plot_footprints.py`	Updated to use `CoordinateSystem`, added exclusion zone plotting
`sharc/satellite/ngso/orbit_model.py`	Added parameter file loading example
`sharc/propagation/*.py`	Multiple propagation models refactored to use `PropagationPath` and updated interfaces
`sharc/parameters/*.py`	Updated parameter classes for new geometry and antenna handling
`sharc/post_processor.py`	Added optional `n_aggregate` parameter for results aggregation
`sharc/main_cli.py`	Replaced getopt with argparse, added log file option
`sharc/campaigns/mss_d2d_to_imt_cross_border/input/.gitignore`	Removed (campaign folder deletion)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-05T20:44:42Z

sharc/support/sharc_logger.py

@@ -102,7 +110,7 @@ def _find_root_dir(self, folder_name: str) -> Optional[Path]:
                return parent
        return None

-    def _run_git_cmd(self, args: list[str]) -> Optional[str]:
+    def _run_git_cmd(self, args: List[str]) -> Optional[str]:


Changed type hint from list[str] to List[str] for Python 3.8 compatibility. However, line 143 has the same pattern that should also be updated.

Copilot · 2025-12-05T20:44:42Z

sharc/station.py


    def __hash__(self):
-        return hash(self.id, self.x, self.y, self.height)
+        return hash(self.id, self.x, self.y, self.z)


The hash() function takes a single argument but is being called with four arguments. This should be return hash((self.id, self.x, self.y, self.z)) with a tuple.

Suggested change

return hash(self.id, self.x, self.y, self.z)

return hash((self.id, self.x, self.y, self.z))

Copilot · 2025-12-05T20:44:42Z

sharc/support/geometry.py

+    pointn_azim_local: np.ndarray  # (N,)
+    pointn_elev_local: np.ndarray  # (N,)
+
+    local_lla_references: np.ndarray[np.ndarray[float]]  # (3, N)


Invalid numpy array type hint syntax. Should use np.ndarray without subscript or use typing constructs like NDArray from numpy.typing if available.

Suggested change

local_lla_references: np.ndarray[np.ndarray[float]] # (3, N)

local_lla_references: np.ndarray # (3, N)

Copilot · 2025-12-05T20:44:43Z

sharc/propagation/propagation_p619.py

+        tau_fs1 = 1.728 + 0.5411 * elevation_deg + 0.03723 * elevation_deg**2
+        tau_fs2 = 0.1815 + 0.06272 * elevation_deg + 0.01380 * elevation_deg**2
+        tau_fs3 = 0.01727 + 0.008288 * elevation_deg


The formulas were changed to use degrees directly instead of radians, but according to ITU-R P.619-1 Attachment B, these calculations should use radians for the elevation angle. The original code with np.deg2rad was correct.

Suggested change

tau_fs1 = 1.728 + 0.5411 * elevation_deg + 0.03723 * elevation_deg**2

tau_fs2 = 0.1815 + 0.06272 * elevation_deg + 0.01380 * elevation_deg**2

tau_fs3 = 0.01727 + 0.008288 * elevation_deg

elevation_rad = np.deg2rad(elevation_deg)

tau_fs1 = 1.728 + 0.5411 * elevation_rad + 0.03723 * elevation_rad**2

tau_fs2 = 0.1815 + 0.06272 * elevation_rad + 0.01380 * elevation_rad**2

tau_fs3 = 0.01727 + 0.008288 * elevation_rad

Copilot · 2025-12-05T20:44:43Z

sharc/station_factory.py

+            while np.sum(mss_d2d.active) == 0:
+                mss_d2d.active[mss_d2d_values["active_satellites_idxs"]] = random_number_gen.uniform(
+                    size=len(mss_d2d_values["active_satellites_idxs"])) < params.beams_load_factor


Infinite loop risk: if params.beams_load_factor is 0, this while loop will never exit since no satellites will ever be set to active.

Copilot · 2025-12-05T20:44:43Z

sharc/parameters/parameters_antenna.py

            for k, v in kwargs.items():
-                if k in dir(param):
+                # we only set if not already set
+                if k in dir(param) and getattr(param, k, None) is None:


Using dir() to check for attribute existence is fragile. Consider using hasattr(param, k) instead for more reliable attribute checking.

Suggested change

if k in dir(param) and getattr(param, k, None) is None:

if hasattr(param, k) and getattr(param, k, None) is None:

…lev_service_grid

fix(utils): Fixed a potential overflow on ecef2lla

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

"visilibity" in the test docstring is misspelled; it should be "visibility" to match the parameter name and improve clarity. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

These two consecutive assertions both check major_minor_axis_ratio against 1.0, which is redundant and makes the test harder to maintain; one of them can be removed without changing test behavior. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…_grid Feat/minimum elev service grid

…into development

This commit adds RigidTransform, ReferenceFrame and ENUReferenceFrame for preparation for usage with other reference frames. SimulatorGeometry was refactored and its API was updated for better maintainability.

… working

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

…g_array Feat/satellite beamforming array

…er class

Feat/antenna 1245 fs

artistrea and others added 30 commits September 11, 2025 17:01

feat(station): single_space_station can now point toward arbitrary la…

e4cb369

…t,lon,alt

update: single_space_station parameters testing pointing_at_(lat|lon|…

a72213d

…alt)

Merge pull request #224 from Radio-Spectrum/feat/space_station_pointi…

4a48819

…ng_at_latlon feat(station): single_space_station can now point toward arbitrary la…

fix(antenna): Fixes an error where the AntennaS1528 frequency

ddf9cf7

was always defaulting to the station frequency.

update(parameters): Removed unused (and dangerous) set_external_param…

6c64380

…eters from Antennas S.672 and S.1528 parameters.

update(tests): Check if all ParametersAntenna sub-params are set

f897a4a

no None. * Defaulting all ParametersAntennaS1528 to None

Merge pull request #225 from Radio-Spectrum/fix/s1528_freq_set

59d377a

Fix/s1528 default frequency

refactor: sharc_geom shrink_country_polygon_by_km -> shrink_lonlat_po…

0775a40

…lygon_by_km

feat: service grid exclusion zone implementation & plot

1cd014c

feat: tests for service grid exclusion zone implementation

1c26dc8

hotfix: plot_footprints script mss d2d parameters

ff2e0fc

fix: exclusion zone missing docstring on public method

dc004ee

Merge pull request #226 from Radio-Spectrum/feat/service_grid_exclusi…

a92ee84

…on_zone Feat/service grid exclusion zone

refactor: geometry converter is now coordinate system

0e52773

Add n_drops to post_processor.py

dde3df0

Add "n_drops" to post_processor.py

4a98e69

Allow user-defined n_aggregate in results aggregation

825f5c4

Solve trailing whitespace error in post_processor.py

0188fcf

Merge pull request #228 from jgarconi/development

6d024ba

update: enhance n_aggregate flexibility in aggregate_results method

Merge pull request #227 from Radio-Spectrum/refactor/geometry_convert…

e7940ce

…er_to_coordinate_sys refactor: geometry converter is now coordinate system

fix: p619 apparent elevation angles

874ee78

Merge pull request #229 from Radio-Spectrum/fix/p619_apparent_angles

8daa7c3

fix: p619 apparent elevation angles

hotfix: p619 es alt

ec54c15

Merge pull request #230 from Radio-Spectrum/hotfix/p619

05a4885

hotfix: p619 es alt

refactor: deleted height parameter from station manager

9f79cc8

feat: simulator geometry

7da87e3

update: geometry readonly global properties & local<>global conversion

f06e5c5

refactor: parameters for service grid

41d5271

hotfix: simulation geometry unset variable

66f974d

fix: station factory mss ss spectral mask parameter

939807b

Copilot AI reviewed Dec 5, 2025

View reviewed changes

brunohcfaria and others added 3 commits December 11, 2025 14:55

fix(utils): Fixed a potential overflow on ecef2lla

1f2e3f6

Merge remote-tracking branch 'origin/development' into feat/minimum_e…

70ef161

…lev_service_grid

Merge pull request #241 from Radio-Spectrum/fix/ecef2lla_overflow

381ae0d

fix(utils): Fixed a potential overflow on ecef2lla

artistrea temporarily deployed to github-pages January 22, 2026 21:42 — with GitHub Actions Inactive

brunohcfaria and others added 5 commits January 29, 2026 11:30

Fixed typo in season error message.

faa33b5

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

"visilibity" in the test docstring is misspelled

6d95bc5

"visilibity" in the test docstring is misspelled; it should be "visibility" to match the parameter name and improve clarity. Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Merge pull request #242 from Radio-Spectrum/feat/minimum_elev_service…

5c30a37

…_grid Feat/minimum elev service grid

Merge branch 'development' of https://github.com/Radio-Spectrum/SHARC …

f5ceb1f

…into development

artistrea temporarily deployed to github-pages January 30, 2026 12:54 — with GitHub Actions Inactive

fabriciofcampos and others added 14 commits January 30, 2026 10:27

update(antenna): Added antenna F.1245 used by FS system

1441145

fix(build): Fixed syntax errors

0ff32ce

fix(build): Added Docstring

57f1844

wip: optimized M.2101 array antenna implementation

8986a18

update!: simulator geometry separate concerns refactor and better API

86f1f72

This commit adds RigidTransform, ReferenceFrame and ENUReferenceFrame for preparation for usage with other reference frames. SimulatorGeometry was refactored and its API was updated for better maintainability.

hotfix: topology sampling from spherical grid

88902e2

update: array antenna for local coordinate system AND faster computation

8df084d

update: antenna array2 in generate_mss_d2d & DWNReferenceFrame for it…

2622b8c

… working

update: better performance for antenna array implementation

e957c90

update: antenna array comments, signatures and minor changes

0dd5d9b

fix: missing comments

f714def

refactor: comments and docstring for better documentation

e7fd325

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

fix: linting errors

0468525

Merge pull request #247 from Radio-Spectrum/feat/satellite_beamformin…

c6edd05

…g_array Feat/satellite beamforming array

brunohcfaria temporarily deployed to github-pages February 10, 2026 10:28 — with GitHub Actions Inactive

fabriciofcampos and others added 3 commits February 11, 2026 18:57

update(antenna): changed ParametersAntennaWithDiameter as the paramet…

42b3ea5

…er class

Fixed antenna_f1245_fs.py header

a4a17e2

Merge pull request #246 from Radio-Spectrum/feat/antenna_1245_fs

48f6620

Feat/antenna 1245 fs

brunohcfaria deployed to github-pages February 12, 2026 17:53 — with GitHub Actions View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Version 2.0.0#239

Version 2.0.0#239
brunohcfaria wants to merge 100 commits intomasterfrom
development

brunohcfaria commented Dec 5, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Copilot AI Dec 5, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	return hash(self.id, self.x, self.y, self.z)
	return hash((self.id, self.x, self.y, self.z))

	local_lla_references: np.ndarray[np.ndarray[float]] # (3, N)
	local_lla_references: np.ndarray # (3, N)

-        tau_fs1 = 1.728 + 0.5411 * elevation_deg + 0.03723 * elevation_deg**2
-        tau_fs2 = 0.1815 + 0.06272 * elevation_deg + 0.01380 * elevation_deg**2
-        tau_fs3 = 0.01727 + 0.008288 * elevation_deg
+        elevation_rad = np.deg2rad(elevation_deg)
+        tau_fs1 = 1.728 + 0.5411 * elevation_rad + 0.03723 * elevation_rad**2
+        tau_fs2 = 0.1815 + 0.06272 * elevation_rad + 0.01380 * elevation_rad**2
+        tau_fs3 = 0.01727 + 0.008288 * elevation_rad

	if k in dir(param) and getattr(param, k, None) is None:
	if hasattr(param, k) and getattr(param, k, None) is None:

Conversation

brunohcfaria commented Dec 5, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 5, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants