deringeorge commited on
Commit
5507184
Β·
unverified Β·
1 Parent(s): 977851b

Initial commit: Project README - SONARIS v0.1

Browse files
Files changed (1) hide show
  1. README.md +474 -2
README.md CHANGED
@@ -1,2 +1,474 @@
1
- # SONARIS
2
- The world's first open-source Ship-Ocean Noise Acoustic Radiated Intelligence System
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ <!-- SONARIS README.md -->
2
+
3
+ <div align="center">
4
+
5
+ # 🌊 SONARIS
6
+ ### Ship-Ocean Noise Acoustic Radiated Intelligence System
7
+
8
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
9
+ [![Status: Active Development](https://img.shields.io/badge/Status-Active%20Development-brightgreen.svg)]()
10
+ [![Platform: Python](https://img.shields.io/badge/Platform-Python%203.10%2B-yellow.svg)](https://www.python.org/)
11
+ [![Made with β™₯ for the Ocean](https://img.shields.io/badge/Made%20with%20%E2%99%A5-for%20the%20Ocean-1ca0f1.svg)]()
12
+ [![Open Source](https://img.shields.io/badge/Open%20Source-Yes-orange.svg)]()
13
+ [![Contributions Welcome](https://img.shields.io/badge/Contributions-Welcome-blueviolet.svg)](CONTRIBUTING.md)
14
+
15
+ <br/>
16
+
17
+ *The world's first open-source platform to predict ship underwater radiated noise, verify IMO compliance, and map acoustic harm to marine mammals β€” free for every shipyard, researcher, and environmental organization on Earth.*
18
+
19
+ <br/>
20
+
21
+ ---
22
+
23
+ </div>
24
+
25
+ ## 🎯 Mission
26
+
27
+ Every day, more than 90,000 commercial vessels carve through the world's oceans, each one broadcasting a wall of underwater noise that travels hundreds of kilometers through water. This anthropogenic din β€” dominated by propeller cavitation, engine vibration, and hull-induced turbulence β€” has transformed the ocean from a realm of biological communication into an acoustic warzone. The IMO's MEPC.1/Circ.906 Rev.1 (2024) guidelines call upon flag states and shipyards to actively manage a vessel's Underwater Radiated Noise (URN), yet as of today, **no free, open, and scientifically rigorous tool exists to help them do so.** Expensive proprietary software remains locked behind paywalls that exclude developing-nation shipyards, independent researchers, and the NGOs fighting hardest for ocean health. SONARIS was built to end that gap. It is a hybrid physics-AI platform that accepts a ship's design parameters and outputs a complete acoustic signature, an IMO compliance verdict, and a biological impact score β€” delivered free, open, and ready to use by anyone in the world.
28
+
29
+ ---
30
+
31
+ ## πŸ”΄ Why SONARIS Exists
32
+
33
+ ### 1. The Regulatory Gap
34
+
35
+ The IMO's **MEPC.1/Circ.906 Rev.1 (2024)** β€” the international community's most current framework for managing ship underwater noise β€” recommends that new ships be designed with URN targets defined by vessel type. Classification societies including Lloyd's Register, DNV, and Bureau Veritas have begun establishing noise notations. Yet there is no standardized, freely accessible computational tool that shipyards can use to predict URN during the design phase, before a ship is ever built. Compliance today depends on expensive tank testing, post-delivery sea trials, or proprietary acoustic suites costing tens of thousands of dollars per license. This is not a gap β€” it is a failure of the engineering ecosystem to match the urgency of the regulatory moment.
36
+
37
+ ### 2. The Environmental Crisis
38
+
39
+ Marine mammals evolved in a pre-industrial ocean where sound was the primary medium of survival β€” for navigation, predation, reproduction, and social bonding. Blue whales communicate across ocean basins. Bottlenose dolphins navigate using biosonar. Right whales call to potential mates across hundreds of kilometers of open water. Ship noise, concentrated in the 10 Hz–1000 Hz band where these species communicate, does not merely disturb them β€” it **masks, disrupts, and in chronic cases physiologically harms** them. Studies have documented measurable changes in humpback whale song structure in shipping corridors. North Atlantic Right Whale populations, already critically endangered, face communication interference across their entire historic range. The ocean is getting louder every decade, and the biological cost is one of the most underreported environmental crises of our time.
40
+
41
+ ### 3. The Access Gap
42
+
43
+ Today, a world-class shipyard in Norway or South Korea can afford the acoustic consultancy fees and proprietary software licenses required to optimize a vessel's noise signature. A shipyard in India, Brazil, or the Philippines cannot. An independent acoustics researcher at a university in West Africa certainly cannot. The environmental NGO monitoring shipping lanes near a marine protected area has no tool at all. SONARIS is built on the conviction that **the physics of sound does not respect economic inequality, and neither should the tools to understand it.** MIT license. Permanently free. Always open.
44
+
45
+ ---
46
+
47
+ ## ⚑ What Makes SONARIS Different
48
+
49
+ Most underwater acoustic tools are black boxes β€” proprietary engines that return a number and offer no insight into the physics producing it. SONARIS is built on a different philosophy: **the science of ship noise is, at its core, the science of sound β€” and sound has a 500-year-old formal theory called music.**
50
+
51
+ ### The Music-Theory-to-Acoustics Methodology
52
+
53
+ The acoustic fingerprint of a ship is not noise in the colloquial sense. It is a structured, analyzable signal with harmonic content, spectral envelopes, tonal peaks, and masking relationships β€” exactly the constructs that music theory and audio signal processing have formalized.
54
+
55
+ SONARIS applies this insight directly:
56
+
57
+ | Music/Audio Concept | SONARIS Application |
58
+ |---|---|
59
+ | **MFCC (Mel-Frequency Cepstral Coefficients)** | Characterizes ship acoustic signature in a perceptually weighted frequency space β€” the same representation used in speech and music recognition, here applied to classify vessel types and operational states from raw hydrophone data |
60
+ | **Harmonic Overlap Analysis** | Identifies tonal peaks in propeller blade-rate harmonics and engine firing frequencies; maps their overlap with the fundamental communication frequencies of target marine mammal species |
61
+ | **Frequency Masking** | Quantifies how ship noise energy in a given band renders biologically critical signals (whale calls, dolphin clicks) inaudible β€” using psychoacoustic masking models adapted from audio engineering |
62
+ | **Spectral Envelope Modeling** | Fits parametric models to the 1/3-octave URN spectrum, enabling interpolation, extrapolation to unmeasured speeds, and comparison across vessel types |
63
+ | **Destructive Interference Principles** | Informs active noise control recommendations: hull panel anti-vibration treatments modeled on acoustic phase-cancellation logic |
64
+
65
+ No other URN prediction tool in the world uses this synthesis. It is SONARIS's core scientific identity.
66
+
67
+ ---
68
+
69
+ ## πŸ—οΈ System Architecture
70
+
71
+ ```mermaid
72
+ flowchart TD
73
+ A["πŸ–₯️ MODULE 1\nDesign Input Engine\n─────────────────\nHull Coefficients\nPropeller Geometry\nEngine Type + RPM\nShip Speed"] --> B
74
+
75
+ B["🧠 MODULE 2\nURN Prediction Core\n─────────────────\nPhysics Layer: OpenFOAM + libAcoustics\nAI Layer: Deep Neural Network\nDatasets: ShipsEar + QiandaoEar22\nOutput: 1/3-Octave Band Spectrum\n(20 Hz β†’ 20 kHz)"]
76
+
77
+ B --> C["πŸ“‹ MODULE 3\nIMO Compliance Checker\n─────────────────\nChecks vs. MEPC.1/Circ.906 Rev.1\nVessel-Type Specific Limits\nDownloadable Compliance Report"]
78
+
79
+ B --> D["πŸ‹ MODULE 4\nMarine Bioacoustic\nImpact Module\n─────────────────\nSpecies Hearing Curves\nBiological Interference Score\nSpectrogram Overlay\nFrequency Masking Analysis"]
80
+
81
+ C --> E["πŸ› οΈ MODULE 5\nMitigation Recommendation\nEngine\n─────────────────\nSpeed Reduction Optimizer\nRouting Avoidance Zones\nHull Panel Modifications\nPropeller Geometry Changes"]
82
+
83
+ D --> E
84
+
85
+ B --> F["πŸ—„οΈ MODULE 6\nOpen URN Database\n─────────────────\nCommunity Contributed\nPublicly Searchable\nFirst Open-Source Ship\nAcoustic Signature Database"]
86
+
87
+ F -.->|"Community Data\nFeedback Loop"| B
88
+
89
+ style A fill:#1a3a5c,color:#fff,stroke:#4a9eff
90
+ style B fill:#0d2137,color:#fff,stroke:#4a9eff
91
+ style C fill:#1a4a2e,color:#fff,stroke:#4aff9e
92
+ style D fill:#4a1a3c,color:#fff,stroke:#ff4aee
93
+ style E fill:#3a2a00,color:#fff,stroke:#ffcc4a
94
+ style F fill:#2a1a4a,color:#fff,stroke:#aa4aff
95
+ ```
96
+
97
+ **Data Flow Summary:**
98
+ 1. User inputs ship design parameters via the web UI or Python API
99
+ 2. The URN Prediction Core generates a full acoustic spectrum using hybrid physics-AI modeling
100
+ 3. The spectrum is simultaneously evaluated by the IMO Compliance Checker and the Marine Bioacoustic Impact Module
101
+ 4. Both outputs feed into the Mitigation Engine, which generates ranked, actionable design recommendations
102
+ 5. All predicted signatures (verified or unverified) can be contributed to the Open URN Database, which feeds back into model training
103
+
104
+ ---
105
+
106
+ ## πŸ“¦ Modules
107
+
108
+ ### Module 1 β€” Design Input Engine
109
+
110
+ **What it does:** Provides a clean web interface (Streamlit) and Python API for ingesting all parameters that define a ship's acoustic profile at the design stage.
111
+
112
+ **Inputs:** Hull form coefficients (Cb, Cp, L/B, T), propeller geometry (diameter, blade count, pitch ratio, skew angle, advance ratio), engine specifications (type, cylinder count, rated RPM, MCR power), and operating speed in knots.
113
+
114
+ **Outputs:** A validated, structured parameter dictionary passed to the URN Prediction Core.
115
+
116
+ **Scientific basis:** Based on established Naval Architecture design parameter conventions; input ranges validated against ITTC (International Towing Tank Conference) standards for propeller geometry.
117
+
118
+ ---
119
+
120
+ ### Module 2 β€” URN Prediction Core (Hybrid AI + Physics)
121
+
122
+ **What it does:** The scientific heart of SONARIS. Produces a full 1/3-octave band underwater radiated noise spectrum from 20 Hz to 20 kHz β€” the complete frequency range relevant to both IMO compliance and marine mammal biology.
123
+
124
+ **Inputs:** Validated design parameters from Module 1.
125
+
126
+ **Outputs:** A 1/3-octave URN spectrum (dB re 1 Β΅Pa @ 1m), tonal peak identification, propeller blade-rate frequency harmonics, and confidence intervals on each band prediction.
127
+
128
+ **Scientific basis:**
129
+ - *Physics layer:* OpenFOAM computational fluid dynamics simulates the propeller inflow field; libAcoustics extracts the far-field acoustic radiation using the Ffowcs Williams–Hawkings (FW-H) equation β€” the gold standard for aeroacoustic and hydroacoustic radiation prediction.
130
+ - *AI layer:* A deep neural network (architecture: 1D-CNN + LSTM hybrid) trained on the ShipsEar and QiandaoEar22 datasets learns the residual mapping between idealized CFD output and real-world measured signatures, correcting for sea-state variability, hull roughness, and operational factors not captured by first-principles simulation.
131
+ - *MFCC feature extraction* is applied to training data to represent ship signatures in a perceptually meaningful frequency space, improving model generalization across vessel types.
132
+
133
+ ---
134
+
135
+ ### Module 3 β€” IMO Compliance Checker
136
+
137
+ **What it does:** Automatically evaluates the predicted URN spectrum against the vessel-type-specific noise targets specified in IMO MEPC.1/Circ.906 Rev.1 (2024) and generates a formatted compliance report.
138
+
139
+ **Inputs:** URN spectrum from Module 2, vessel type classification (cargo, tanker, passenger, etc.).
140
+
141
+ **Outputs:** A pass/fail compliance assessment per frequency band, a full downloadable PDF compliance report, and a decibel-margin analysis showing exactly how much headroom or exceedance exists in each band.
142
+
143
+ **Scientific basis:** IMO MEPC.1/Circ.906 Rev.1 (2024) noise level targets; supplemented by DNV GL noise notation criteria for vessels seeking acoustic classification.
144
+
145
+ ---
146
+
147
+ ### Module 4 β€” Marine Bioacoustic Impact Module *(Core Differentiator)*
148
+
149
+ **What it does:** Maps the predicted ship noise spectrum onto the hearing sensitivity and communication frequency ranges of five marine mammal functional hearing groups, producing a quantitative Biological Interference Score (BIS) for each group.
150
+
151
+ **Inputs:** URN spectrum from Module 2; published audiogram data for low-frequency cetaceans (baleen whales), mid-frequency cetaceans (dolphins, toothed whales), high-frequency cetaceans (porpoises), pinnipeds in water (seals, sea lions), and sirenians (manatees, dugongs).
152
+
153
+ **Outputs:**
154
+ - Biological Interference Score (BIS) per species group (0–100 scale, where 100 = complete masking of primary communication band)
155
+ - Spectrogram overlay visualization: ship noise vs. species communication envelope
156
+ - Frequency masking analysis: proportion of species vocal repertoire rendered inaudible at a given received level
157
+ - Harmonic overlap report: tonal peaks in ship signature that fall within Β±1/3 octave of recorded call frequencies
158
+
159
+ **Scientific basis:** NOAA's marine mammal acoustic criteria; Southall et al. (2019) noise exposure criteria; Au & Hastings (2008) audiogram compilations; psychoacoustic masking models adapted from Moore (2012).
160
+
161
+ ---
162
+
163
+ ### Module 5 β€” Mitigation Recommendation Engine
164
+
165
+ **What it does:** Analyzes the compliance gaps and biological impact scores and generates a prioritized, actionable set of design and operational modifications to bring the vessel into compliance and minimize ecological harm.
166
+
167
+ **Inputs:** Compliance gap analysis from Module 3; BIS scores from Module 4; original design parameters.
168
+
169
+ **Outputs:** Ranked mitigation recommendations including: optimized speed profiles, alternate routing around marine protected areas, propeller geometry adjustments (skew, rake, pitch ratio), hull panel damping treatment specifications, and cavitation-suppression design strategies.
170
+
171
+ **Scientific basis:** ITTC propeller noise reduction guidelines; Carlton (2012) propeller blade design for noise optimization; IMO speed reduction studies.
172
+
173
+ ---
174
+
175
+ ### Module 6 β€” Open URN Database
176
+
177
+ **What it does:** Hosts the world's first open-source, community-contributed database of ship underwater acoustic signatures β€” searchable by vessel type, propulsion system, speed, and frequency band.
178
+
179
+ **Inputs:** Community submissions of measured or predicted URN spectra, with associated ship metadata.
180
+
181
+ **Outputs:** Publicly queryable dataset for research, model validation, regulatory benchmarking, and fleet-wide trend analysis.
182
+
183
+ **Scientific basis:** Modeled on open scientific data principles (FAIR β€” Findable, Accessible, Interoperable, Reusable); data quality validated against ShipsEar and QiandaoEar22 baseline distributions before ingestion.
184
+
185
+ ---
186
+
187
+ ## πŸ‘₯ Who This Is For
188
+
189
+ | Audience | How SONARIS Serves Them |
190
+ |---|---|
191
+ | **Shipyards & Naval Architects** | Predict and optimize URN at the design stage β€” before steel is cut β€” reducing costly post-delivery retrofits |
192
+ | **Classification Societies** (Lloyd's Register, DNV, BV, ABS) | Standardized, reproducible URN assessment tool to support acoustic noise notation verification |
193
+ | **Environmental NGOs** (WWF, Ocean Conservation Trust, IFAW) | Quantify the biological impact of shipping traffic on marine mammal populations with a defensible, published methodology |
194
+ | **Naval Defense Organizations** | Acoustic signature modeling for vessel design and fleet management β€” open architecture allows custom extension |
195
+ | **Port Authorities** | Evaluate noise contribution of different vessel types using their ports; model quiet shipping incentive programs |
196
+ | **Ocean Researchers & Academics** | Open-source, reproducible acoustic modeling platform; accessible URN database for research; no license fees |
197
+ | **Regulatory Bodies** (IMO, Flag State Administrations) | Reference implementation of MEPC.1/Circ.906 Rev.1 compliance assessment; supports policy development with quantitative data |
198
+
199
+ ---
200
+
201
+ ## πŸ—ΊοΈ Roadmap
202
+
203
+ ### Phase 0 β€” Foundation *(Current)*
204
+ - [x] Project architecture designed and documented
205
+ - [x] Technical stack selected and validated
206
+ - [x] Dataset sources identified (ShipsEar, QiandaoEar22, IMO guidelines, audiograms)
207
+ - [x] README and project identity established
208
+ - [ ] GitHub repository initialized with folder structure
209
+ - [ ] Development environment configured (OpenFOAM, PyTorch, Streamlit)
210
+ - [ ] Core data pipeline: raw hydrophone audio β†’ 1/3-octave spectrum
211
+
212
+ ### Phase 1 β€” URN Prediction Core *(Q2 2025)*
213
+ - [ ] Physics layer: OpenFOAM + libAcoustics propeller noise simulation pipeline
214
+ - [ ] AI layer: 1D-CNN + LSTM model trained on ShipsEar dataset
215
+ - [ ] MFCC feature extraction pipeline for ship audio signatures
216
+ - [ ] Cross-validation against QiandaoEar22 dataset
217
+ - [ ] Benchmark: prediction accuracy within Β±3 dB across 1/3-octave bands
218
+ - [ ] Module 1 (Design Input Engine) β€” Streamlit UI v1.0
219
+ - [ ] Module 2 (URN Prediction Core) β€” Python API v1.0
220
+
221
+ ### Phase 2 β€” Compliance + Bioacoustics *(Q3 2025)*
222
+ - [ ] Module 3 (IMO Compliance Checker) β€” Full MEPC.1/Circ.906 Rev.1 rule set implemented
223
+ - [ ] Downloadable PDF compliance report generation
224
+ - [ ] Module 4 (Bioacoustic Impact) β€” Five functional hearing group audiogram integration
225
+ - [ ] Biological Interference Score (BIS) algorithm validated against published masking studies
226
+ - [ ] Spectrogram overlay visualization β€” ship noise vs. whale/dolphin communication bands
227
+ - [ ] Harmonic overlap analysis engine
228
+ - [ ] Module 5 (Mitigation Engine) β€” v1.0 recommendation set
229
+
230
+ ### Phase 3 β€” Community + Scale *(Q4 2025 – 2026)*
231
+ - [ ] Module 6 (Open URN Database) β€” Public launch with seed data
232
+ - [ ] Community contribution pipeline with data quality validation
233
+ - [ ] REST API for programmatic access to all modules
234
+ - [ ] Integration with AIS ship tracking data for real-time fleet noise estimation
235
+ - [ ] Peer-reviewed methodology paper submitted to Journal of the Acoustical Society of America
236
+ - [ ] Formal outreach to IMO, Lloyd's Register, and WWF for adoption and feedback
237
+ - [ ] Multi-language support (Spanish, French, Mandarin, Arabic)
238
+ - [ ] PostgreSQL database migration for production scale
239
+
240
+ ---
241
+
242
+ ## πŸ› οΈ Tech Stack
243
+
244
+ | Category | Tool | Purpose |
245
+ |---|---|---|
246
+ | **Core Language** | Python 3.10+ | Primary development language across all modules |
247
+ | **Deep Learning** | PyTorch | URN prediction neural network (1D-CNN + LSTM architecture) |
248
+ | **Machine Learning** | scikit-learn | Feature engineering, model evaluation, cross-validation |
249
+ | **Audio/Acoustics** | librosa | MFCC extraction, spectral analysis, 1/3-octave band processing |
250
+ | **Signal Processing** | scipy.signal | Filtering, FFT, spectral density estimation |
251
+ | **Acoustic Simulation** | mSOUND | 3D acoustic wave propagation modeling |
252
+ | **CFD Simulation** | OpenFOAM | Propeller cavitation and turbulent flow simulation |
253
+ | **Hydroacoustics** | libAcoustics | FW-H acoustic analogy β€” far-field URN radiation from CFD data |
254
+ | **Web UI** | Streamlit | Design input interface, visualization dashboard |
255
+ | **Visualization** | Plotly | Interactive spectrogram overlays, compliance charts |
256
+ | **Visualization** | Matplotlib / Seaborn | Publication-quality static plots |
257
+ | **Database (dev)** | SQLite | Local URN database and session management |
258
+ | **Database (prod)** | PostgreSQL | Production-scale Open URN Database |
259
+ | **PDF Generation** | ReportLab | Downloadable IMO compliance reports |
260
+ | **Deployment** | Hugging Face Spaces / Streamlit Cloud | Free, accessible public hosting |
261
+ | **Version Control** | GitHub | Open-source repository and community collaboration |
262
+
263
+ ---
264
+
265
+ ## πŸ“Š Datasets
266
+
267
+ SONARIS is built on, and will contribute back to, the following open scientific resources:
268
+
269
+ ### ShipsEar
270
+ > Santos-DomΓ­nguez, D., Torres-Guijarro, S., Cardenal-LΓ³pez, A., & Pena, A. (2016). **ShipsEar: An underwater vessel noise database.** *Applied Acoustics, 113*, 64–69. https://doi.org/10.1016/j.apacoust.2016.06.008
271
+
272
+ A landmark public dataset containing recordings of 11 different ship and boat classes captured by hydrophone. Used for training the vessel-type classification and URN spectrum prediction components of Module 2.
273
+
274
+ ### QiandaoEar22
275
+ > [Authors]. **QiandaoEar22: A High-Quality Ship-Radiated Noise Dataset.** *arXiv:2406.04354* (2024). https://arxiv.org/abs/2406.04354
276
+
277
+ A high-quality, recent dataset of ship-radiated underwater noise with rich metadata. Used for cross-validation, model fine-tuning, and benchmarking URN prediction accuracy.
278
+
279
+ ### Marine Mammal Audiograms
280
+ > Au, W.W.L., & Hastings, M.C. (2008). **Principles of Marine Bioacoustics.** Springer, New York.
281
+
282
+ > Southall, B.L., et al. (2019). Marine mammal noise exposure criteria: Updated scientific recommendations for residual hearing effects. **Aquatic Mammals, 45(2)**, 125–232.
283
+
284
+ Published hearing sensitivity (audiogram) data for five functional hearing groups: low-frequency cetaceans, mid-frequency cetaceans, high-frequency cetaceans, pinnipeds in water, and sirenians. Core data source for Module 4.
285
+
286
+ ### IMO MEPC.1/Circ.906 Rev.1 (2024)
287
+ > International Maritime Organization. (2024). **Guidelines for the Reduction of Underwater Noise from Commercial Shipping to Address Adverse Impacts on Marine Life.** *MEPC.1/Circ.906 Rev.1.* IMO, London.
288
+
289
+ The authoritative international regulatory framework implemented in Module 3. Defines vessel-type-specific URN targets and measurement methodologies.
290
+
291
+ ---
292
+
293
+ ## πŸš€ Getting Started
294
+
295
+ ### Prerequisites
296
+
297
+ - Python 3.10 or higher
298
+ - OpenFOAM v2306+ (for physics simulation layer)
299
+ - Git
300
+
301
+ ### Installation
302
+
303
+ ```bash
304
+ # 1. Clone the repository
305
+ git clone https://github.com/your-username/sonaris.git
306
+ cd sonaris
307
+
308
+ # 2. Create and activate a virtual environment (recommended)
309
+ python -m venv venv
310
+ source venv/bin/activate # On Windows: venv\Scripts\activate
311
+
312
+ # 3. Install Python dependencies
313
+ pip install -r requirements.txt
314
+
315
+ # 4. (Optional) Configure environment variables
316
+ cp .env.example .env
317
+ # Edit .env with your database path and any API keys
318
+
319
+ # 5. Launch the SONARIS web interface
320
+ streamlit run app.py
321
+ ```
322
+
323
+ The application will open in your browser at `http://localhost:8501`.
324
+
325
+ ### Python API (Headless Usage)
326
+
327
+ ```python
328
+ from sonaris import URNPredictor, ComplianceChecker, BioacousticImpact
329
+
330
+ # Define vessel parameters
331
+ vessel = {
332
+ "length": 180.0, # meters
333
+ "beam": 28.0, # meters
334
+ "draft": 10.5, # meters
335
+ "block_coefficient": 0.78,
336
+ "propeller_diameter": 6.2, # meters
337
+ "blade_count": 4,
338
+ "pitch_ratio": 0.85,
339
+ "engine_rpm": 120,
340
+ "speed_knots": 14.0,
341
+ "vessel_type": "cargo"
342
+ }
343
+
344
+ # Predict URN spectrum
345
+ predictor = URNPredictor()
346
+ spectrum = predictor.predict(vessel)
347
+
348
+ # Check IMO compliance
349
+ compliance = ComplianceChecker().evaluate(spectrum, vessel_type="cargo")
350
+ print(compliance.report())
351
+
352
+ # Calculate biological impact
353
+ impact = BioacousticImpact().score(spectrum)
354
+ print(impact.biological_interference_scores)
355
+ ```
356
+
357
+ ---
358
+
359
+ ## 🀝 Contributing
360
+
361
+ SONARIS is built on the conviction that the best solutions to global environmental problems come from globally diverse expertise. We are actively seeking contributors from every technical and scientific background.
362
+
363
+ ### Who We Need
364
+
365
+ - **Naval Architects & Marine Engineers** β€” Help validate hull-propeller acoustic models and expand the design parameter space
366
+ - **Underwater Acousticians** β€” Challenge and improve our URN prediction methodology; contribute measured data
367
+ - **Marine Biologists & Bioacousticians** β€” Improve species audiogram integration, validate BIS scoring, expand species coverage
368
+ - **Machine Learning Engineers** β€” Improve model architecture, training pipelines, and uncertainty quantification
369
+ - **Oceanographers** β€” Help incorporate propagation environment (depth, temperature, salinity) into URN spread modeling
370
+ - **Software Engineers** β€” API design, database architecture, performance optimization, testing infrastructure
371
+ - **Data Scientists** β€” Feature engineering, exploratory analysis of URN datasets, model benchmarking
372
+
373
+ ### How to Contribute
374
+
375
+ 1. Fork the repository
376
+ 2. Create a feature branch: `git checkout -b feature/your-contribution`
377
+ 3. Commit with clear messages: `git commit -m "Add: [description]"`
378
+ 4. Push and open a Pull Request with a detailed description of the scientific or technical rationale
379
+
380
+ Please read [CONTRIBUTING.md](CONTRIBUTING.md) for our full code standards, testing requirements, and scientific validation protocols before submitting.
381
+
382
+ > We hold contributions to the same standard as peer-reviewed science β€” claims must be justified, methods must be reproducible, and uncertainty must be acknowledged. If you're new to open-source contribution, we will guide you through the process.
383
+
384
+ ---
385
+
386
+ ## πŸ“š Scientific References
387
+
388
+ 1. **Santos-DomΓ­nguez, D., Torres-Guijarro, S., Cardenal-LΓ³pez, A., & Pena, A.** (2016). ShipsEar: An underwater vessel noise database. *Applied Acoustics, 113*, 64–69. https://doi.org/10.1016/j.apacoust.2016.06.008
389
+
390
+ 2. **IMO.** (2024). Guidelines for the Reduction of Underwater Noise from Commercial Shipping to Address Adverse Impacts on Marine Life. *MEPC.1/Circ.906 Rev.1.* International Maritime Organization, London.
391
+
392
+ 3. **Southall, B.L., et al.** (2019). Marine mammal noise exposure criteria: Updated scientific recommendations for residual hearing effects. *Aquatic Mammals, 45(2)*, 125–232. https://doi.org/10.1578/AM.45.2.2019.125
393
+
394
+ 4. **Ffowcs Williams, J.E., & Hawkings, D.L.** (1969). Sound generation by turbulence and surfaces in arbitrary motion. *Philosophical Transactions of the Royal Society A, 264(1151)*, 321–342. *(Theoretical foundation for far-field hydroacoustic radiation in the physics layer)*
395
+
396
+ 5. **Au, W.W.L., & Hastings, M.C.** (2008). *Principles of Marine Bioacoustics.* Springer, New York. https://doi.org/10.1007/978-0-387-47564-1
397
+
398
+ 6. **Ross, D.** (1976). *Mechanics of Underwater Noise.* Pergamon Press. *(Foundational theory for ship-radiated noise source mechanisms)*
399
+
400
+ 7. **Davis, S., & Mermelstein, P.** (1980). Comparison of parametric representations for monosyllabic word recognition in continuously spoken sentences. *IEEE Transactions on Acoustics, Speech, and Signal Processing, 28(4)*, 357–366. *(Original MFCC formulation; basis for SONARIS spectral feature extraction)*
401
+
402
+ 8. **Moore, B.C.J.** (2012). *An Introduction to the Psychology of Hearing* (6th ed.). Brill. *(Psychoacoustic masking models applied in Module 4)*
403
+
404
+ 9. **Carlton, J.** (2012). *Marine Propellers and Propulsion* (3rd ed.). Butterworth-Heinemann. *(Propeller geometry, cavitation, and noise generation β€” engineering basis for Modules 1 and 5)*
405
+
406
+ 10. **Hildebrand, J.A.** (2009). Anthropogenic and natural sources of ambient noise in the ocean. *Marine Ecology Progress Series, 395*, 5–20. https://doi.org/10.3354/meps08353
407
+
408
+ ---
409
+
410
+ ## πŸ“œ License
411
+
412
+ ```
413
+ MIT License
414
+
415
+ Copyright (c) 2025 SONARIS Project
416
+
417
+ Permission is hereby granted, free of charge, to any person obtaining a copy
418
+ of this software and associated documentation files (the "Software"), to deal
419
+ in the Software without restriction, including without limitation the rights
420
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
421
+ copies of the Software, and to permit persons to whom the Software is
422
+ furnished to do so, subject to the following conditions:
423
+
424
+ The above copyright notice and this permission notice shall be included in all
425
+ copies or substantial portions of the Software.
426
+
427
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
428
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
429
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
430
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
431
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
432
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
433
+ SOFTWARE.
434
+ ```
435
+
436
+ SONARIS will remain free, forever. Not as a business decision β€” as a moral one.
437
+
438
+ ---
439
+
440
+ ## πŸ§‘β€πŸ’» Built By
441
+
442
+ SONARIS was conceived and is being built by a third-year Naval Architecture & Ocean Engineering student in India who came to this problem from two directions at once.
443
+
444
+ From engineering: a technical education in hull hydrodynamics, propeller theory, and ship structural design β€” the physics of how ships move through water and what that motion radiates outward.
445
+
446
+ From music: years spent as a composer, building an intuition for frequency, harmonic structure, spectral texture, and the mathematics of how sounds interact β€” how one frequency masks another, how harmonics reinforce or cancel, how a spectrum tells a story.
447
+
448
+ The intersection of these two educations produced a question that no existing tool had answered: *What if you approached the acoustic fingerprint of a ship the way a sound engineer approaches a recording β€” not as noise to be measured, but as a signal to be understood?*
449
+
450
+ SONARIS is the answer to that question.
451
+
452
+ This project is not a university assignment. It is a genuine attempt to build something the world needs: a free, rigorous, open, and beautiful tool that helps the people designing, regulating, and protecting the ocean make better decisions β€” decisions that will determine whether the creatures that evolved to live in acoustic darkness can continue to speak to each other across the deep.
453
+
454
+ > *"The sea, once it casts its spell, holds one in its net of wonder forever."*
455
+ > β€” Jacques Cousteau
456
+
457
+ If you share that wonder β€” and the conviction that engineering should serve it β€” welcome to SONARIS.
458
+
459
+ ---
460
+
461
+ <div align="center">
462
+
463
+ **🌊 Built for the Ocean. Open to the World. 🌊**
464
+
465
+ <br/>
466
+
467
+ *If SONARIS is useful to your work β€” at a shipyard, a research institution, an NGO, or a regulatory body β€” please star the repository, open an issue, or write to us. Every signal of impact helps justify the work and grow the community.*
468
+
469
+ <br/>
470
+
471
+ [![GitHub Stars](https://img.shields.io/github/stars/your-username/sonaris?style=social)](https://github.com/your-username/sonaris)
472
+ [![GitHub Forks](https://img.shields.io/github/forks/your-username/sonaris?style=social)](https://github.com/your-username/sonaris)
473
+
474
+ </div>