search

ImperialCollegeLondon / MAG-Data-Visualization-Toolbox

MATLAB Data Visualization for MAG data.
MIT License
0 stars 1 forks source link

readme

MAG Data Visualization Toolbox

Imperial College Space Magnetometer Laboratory MATLAB Tests View MAG Data Visualization Toolbox on File Exchange

This repository contains utilities for processing and visualizing MAG science and HK data. The supported MATLAB releases are MATLAB R2023b and later. The following MATLAB toolboxes are required to use the toolbox:

Getting Started

The toolbox adds to the path many functions and classes that can be used for data processing and visualization. These can be found under the mag namespace; you can use tab-completion to see what is available:

mag.<TAB>

In the sections below you can find more information about some of the functionalities.

User Manual

See internal documentation on Confluence.

Development

When developing new features or fixing issues, create a new branch. After finishing development, make sure to write tests to cover any new changes.

To change the version of the toolbox, modify the MAG_DATA_VISUALIZATION_VERSION variable in .env. This will automatically updated the toolbox version and create a new release with the correct tag. Also, update the contents of the resources/release-notes.md file by detailing what has changed in the new version.

License

MAG Data Visualization Toolbox is released under the MIT license.