<!-- 
Author(s): Shibaji Chakraborty, Xueling Shi

Disclaimer:
SCUBAS is under the MIT license found in the root directory LICENSE.md 
Everyone is permitted to copy and distribute verbatim copies of this license 
document.

This version of the MIT Public License incorporates the terms
and conditions of MIT General Public License.
-->

[![License: MIT](https://img.shields.io/badge/License%3A-MIT-green)](https://choosealicense.com/licenses/mit/) 
[![Python 3.11](https://img.shields.io/badge/python-3.11-blue.svg)](https://www.python.org/downloads/release/python-3110/) 
![GitHub Stable Release (latest by date)](https://img.shields.io/github/v/release/shibaji7/SCUBAS)
[![Documentation Status](https://img.shields.io/readthedocs/SCUBAS?logo=readthedocs&label=docs)](https://SCUBAS.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/shibaji7/SCUBAS/branch/main/graph/badge.svg)](https://codecov.io/gh/shibaji7/SCUBAS)

# SCUBAS
SUCBAS: **S**ubmarine **C**ables **U**pset **b**y **A**uroral **S**treams.

<div class="hero">
  <h2>Submarine Cable Geomagnetic Disturbance Modeling</h2>
  <p>
    SCUBAS provides a physics-based workflow for estimating voltage induced on
    submarine cables during geomagnetic storm conditions.
  </p>
</div>

SCUBAS is an open source Python-based computational model of geomagnetic induction on submarine cables. The model is used to estimate the induced voltage in the submarine cables in response to geomagnetic disturbances. It utilizes newly acquired knowledge from magnetotelluric studies and associated investigations of geomagnetically induced currents in power systems.

## Source Code 

The library source code can be found on the [SCUBAS GitHub](https://github.com/shibaji7/SCUBAS) repository. 

If you have any questions or concerns please submit an **Issue** on the [SCUBAS GitHub](https://github.com/shibaji7/SCUBAS) repository. 

## Documentation Links

<div class="doc-card-grid">
  <div class="doc-card">
    <strong>Installation</strong>
    Environment setup, dependencies, and package installation.<br>
    <a href="user/install/">Open Installation</a>
  </div>
  <div class="doc-card">
    <strong>Data & Citation</strong>
    INTERMAGNET access and citation guidance.<br>
    <a href="user/intermagnet/">INTERMAGNET</a> | <a href="user/citing/">Citing</a>
  </div>
  <div class="doc-card">
    <strong>Tutorials</strong>
    Theory, storm-event studies, and uncertainty workflows.<br>
    <a href="tutorial/theory/">Open Tutorials</a>
  </div>
  <div class="doc-card">
    <strong>API Reference</strong>
    Cables, conductivity, models, utilities, and plotting modules.<br>
    <a href="dev/">Open API</a>
  </div>
</div>
