Home

Project organisation

.
├── LICENSE
├── README.md
├── data
│   ├── external       <- Data that is sourced from elsewhere (these can be part of the repository if light)
│   ├── downloaded     <- Data that can be automatically downloaded by a script within src
├── notebooks          <- Jupyter notebooks (tutorials)
└── src                <- Source code for this project

src:

• field_line_tracer.py
• mag_lib.py
• sha_lib.py
• ? fetch_data.py (populates data/downloaded)
• ...

notebooks:

• K-index-calculation
• Orbservatory bartels plots
• Field line tracing
• SHA
• ...

Data:

• To produce a global model from Swarm data - have a Swarm Virtual Observatory data file
• Have the BGS Observatory annual means data file - with all baseline jumps applied
• Have Eskdalemuir one-minute data for 2003 in day files in IAGA2002 format (K-index notebook)
• Have Eskdalemuir K-indices in year files in local BGS format (K-index notebook)
• Have a world map 'ones and zeros' data file for SHA demonstration

TODO:

• How to fetch the observatory data?
• Relative imports of src within notebooks, correct paths for data
• Notebook index and introductory blurb
• Links to related resources
• Write instructions for setup (not required when deployed on VRE already for students, but some can choose to set it up locally if they want)
  • conda env requirements
  • git clone ...
  • python src/fetch_data.py

Deployment on VRE (Ashley):

• VRE should be ready in May?
• EOX to create user accounts for students - each student will receive by email: [url,username,password]
  • need to get a list of email addresses
• repo is cloned to VRE and duplicated to each user home space