https://github.com/mathworks/open-gravitational-wave-data-matlab

This is a tutorial demonstrating how to access open gravitational wave data and publish reusable and reproducible analyses in MATLAB
https://github.com/mathworks/open-gravitational-wave-data-matlab

open-data open-science

Last synced: 7 months ago
JSON representation

This is a tutorial demonstrating how to access open gravitational wave data and publish reusable and reproducible analyses in MATLAB

• Host: GitHub
• URL: https://github.com/mathworks/open-gravitational-wave-data-matlab
• Owner: mathworks
• License: bsd-2-clause
• Created: 2023-11-03T10:30:34.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-01-05T16:11:41.000Z (over 2 years ago)
• Last Synced: 2025-01-03T11:11:39.548Z (over 1 year ago)
• Topics: open-data, open-science
• Language: Jupyter Notebook
• Homepage:
• Size: 16.9 MB
• Stars: 2
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

          
[![View open-gravitational-wave-data-matlab on File Exchange](https://www.mathworks.com/matlabcentral/images/matlab-file-exchange.svg)](https://www.mathworks.com/matlabcentral/fileexchange/154551-open-gravitational-wave-data-matlab)

[![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=mathworks/open-gravitational-wave-data-matlab&file=OpenPhysicsTutorial.mlx)

# Analyse Open Gravitational Wave Data in MATLAB®

A MATLAB Live Script with accompanying 

- [Jupyter® Notebook](https://github.com/mathworks/open-gravitational-wave-data-matlab/blob/main/OpenPhysicsTutorial.ipynb), 

- [.m file](https://github.com/mathworks/open-gravitational-wave-data-matlab/blob/main/OpenPhysicsTutorialScript.m) and 

- [reproducible code capsule on Code Ocean®](https://doi.org/10.24433/CO.6147849.v1)

to access and analyze Gravitational Wave data sets from the **Gravitational Wave Open Science Center (GWOSC)** database

## Get started

Use this tutorial to get started with freely available gravitational wave data at [GWOSC](https://gwosc.org/) directly from MATLAB.

- No downloads, no installations

- **Open directly in MATLAB Online** by clicking this [![Open in MATLAB Online](https://www.mathworks.com/images/responsive/global/open-in-matlab-online.svg)](https://matlab.mathworks.com/open/github/v1?repo=mathworks/open-gravitational-wave-data-matlab&file=OpenPhysicsTutorial.mlx)

- Step-by-step tutorial shows how to

    - Re-use available gravitational wave data. **Access a list of openly available events and sessions** from LIGO, Virgo and Kagra

    - **Query and inspect the metadata** associated with these projects using commands directly from MATLAB (RESTful API)

    - Avoid downloads. **Access specific data** from within the database directly and **avoid time-consuming downloads** of large data

    - **Read in HDf5 data** from within MATLAB corresponding to specific sampling rates and detectors

    - **Analyze gravitational wave data** using standard signal processing in time and frequency domains **re-using [open community](https://de.mathworks.com/matlabcentral/fileexchange/108859-gravitationalwavedataexplorer?tab=example&focused=) code from File Exchange**

    - Let others run your code and reproduce your results quickly. **Pubish the results on GitHub** and **make them accessible** using Open With MATLAB Online

    - Allow people to cite you! **Generate a DOI** for your code by linking your GitHub repository to one of several DOI-generating sites.

- **Live Script** contains **easy-to-use menus** for user to click and select different datasets

- Available on [**File Exchange**](https://www.mathworks.com/matlabcentral/fileexchange/) for directly installing onto your MATLAB path with one click using the [Add-Ons button](https://www.mathworks.com/help/matlab/matlab_env/get-add-ons.html)

- Accompanying **Jupyter notebook** (.ipynb) for use in a Jupyter environment. More information on MATLAB kernel [here](https://www.mathworks.com/products/reference-architectures/jupyter.html)

- Accompanying **Code Ocean reproducible capsule** (.m) for one-click reproducibility of the code by anyone, including reviewers.

## About the Gravitational Wave Open Science Center 

The Gravitational Wave Open Science Center (GWOSC) is a public repository of gravitational wave events and experimental sessions from LIGO, Virgo and Kagra for the community.

It can be accessed at [https://gwosc.org/](https://gwosc.org/). [Here](https://gwosc.org/eventapi/html/GWTC/) is a list of available GW events from GWOSC.

**For advanced users** A detailed guide to the GWOSC API can be found [here](https://gwosc.org/apidocs/). To access the REST API use the MATLAB [webread](https://www.mathworks.com/help/matlab/ref/webread.html) function

### Required Products

This tutorial uses the following products

- MATLAB

- Signal Processing Toolbox

This code has been developed and tested using MATLAB 2023a

**Note**

This tutorial works best when delivered by a tutor. It is important to highlight best practices when working with Open Data, publishing Open Code or making research output reproducible