Skip to content

Files

Latest commit

kylermurphykylermurphy
linking to tutorials
Feb 15, 2024
3219a1d · Feb 15, 2024

History

History
40 lines (25 loc) · 2.21 KB

README.md

File metadata and controls

40 lines (25 loc) · 2.21 KB

GMAG

gmag is an open-source Python library to access ground-based magnetometer data.

The notebooks in this tutorial will go over the basics of GMAG, loading data, accessing data & metadata, identifying stations in key locations, and plotting & basic analysis of data.

The notebooks can be ran in either:

  1. Google Colab: this method is the simplest and requires no Python distribution, installation of any code, or downloading of data to your computer. This is ideal if you only want to follow along with the tutorial.
  2. Locally on your computer: this method requires you to download and install the GMAG package and set your download directory. It also requires a Python distribution (I suggest Anaconda). This is ideal if you intend on using ground-based magnetometer data.

If you choose to run GMAG locally follow the Installation Instruction below.

Tutorial Notebooks

Based on your preference click the Colab link below to open the tutorial in Colab or download the Local Notebook to run the tutorial locally.

GMAG Installation

  • Download (and unzip) the GMAG github repository to your Python/Coding directory.
  • Open a terminal and navigate to the GMAG directory.
    • If you've install Anacond open and cd to the GMAG directory.
  • Now install the GMAG package using:
pip install .
  • Once installed you need to rename or copy the /gmag/gmag_rcexample file to /gmag/gmagrc
  • Open /gmag/gmagrc and modify the data_dir variable by adding the local directory where you would like all ground-based magnetometer data to be downloaded.
  • You should now be able to use GMAG.