Coverage for python / aubellhop / main.py: 100%

1"""AUBELLHOP: Python interface for the Bellhop underwater acoustic propagation models. 

2 

3This toolbox uses the Bellhop acoustic propagation model. For this model 

4to work, the complete aubellhop package must be built and installed 

5and `bellhop.exe` should be in your PATH. 

6 

7Copyright (c) 2025-, Will Robertson 

8Copyright (c) 2018-2025, Mandar Chitre 

9 

10This file was originally part of arlpy, released under Simplified BSD License. 

11It has been relicensed in this repository to be compatible with the Bellhop licence (GPL). 

12""" 

13 

14from __future__ import annotations 

15 

16# this format to explicitly mark the functions as public: 

17from aubellhop.readers import read_ssp as read_ssp 

18from aubellhop.readers import read_ssp_3d as read_ssp_3d 

19from aubellhop.readers import read_ati as read_ati 

20from aubellhop.readers import read_bty as read_bty 

21from aubellhop.readers import read_sbp as read_sbp 

22from aubellhop.readers import read_trc as read_trc 

23from aubellhop.readers import read_brc as read_brc 

24 

25from aubellhop.readers import read_rays as read_rays 

26from aubellhop.readers import read_arrivals as read_arrivals 

27 

28from aubellhop.environment import Environment as Environment 

29from aubellhop.models import Models as Models 

30 

31from aubellhop.compute import compute_from_file as compute_from_file 

32from aubellhop.compute import compute as compute 

33from aubellhop.compute import compute_rays as compute_rays 

34from aubellhop.compute import compute_eigenrays as compute_eigenrays 

35from aubellhop.compute import compute_arrivals as compute_arrivals 

36from aubellhop.compute import compute_transmission_loss as compute_transmission_loss 

37from aubellhop.compute import arrivals_to_impulse_response as arrivals_to_impulse_response 

38 

39from aubellhop.demo import demo as demo 

40 

41### Export module names for auto-importing in __init__.py 

42 

43__all__ = [ 

44 name for name in globals() if not name.startswith("_") # ignore private names 

45]