Data

Tools

Indexes

Applications

Experiments

Open Source Science

irfu-matlab

Matlab routines to work with space data, particularly with MMS and Cluster/CAA data. Also some general plasma routines.

https://github.com/irfu/irfu-matlab

Science Score: 67.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 1 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (17.0%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Matlab routines to work with space data, particularly with MMS and Cluster/CAA data. Also some general plasma routines.

Basic Info
  • Host: GitHub
  • Owner: irfu
  • Language: MATLAB
  • Default Branch: master
  • Homepage:
  • Size: 513 MB
Statistics
  • Stars: 70
  • Watchers: 34
  • Forks: 47
  • Open Issues: 24
  • Releases: 2
Created almost 13 years ago · Last pushed 6 months ago
Metadata Files
Readme Contributing Citation Codeowners Security

README.md

irfu-matlab ci-build DOI

Acknowledgment

Please use the following to acknowledge use of IRFU-Matlab in your publications:

Data analysis was performed using the IRFU-Matlab analysis package available at https://github.com/irfu/irfu-matlab

Examples

A few examples of irfu-matlab usage can be seen under web page https://sites.google.com/site/irfumatlab/

Installation

Download the code and add to the Matlab path the directory 'irfu-matlab'. Two methods are described below, a plain basic install and a more development oriented install (for contributors).

Basic install

If you intend to use irfu-matlab without pushing code then to simply download the code from the command line run

sh git clone https://github.com/irfu/irfu-matlab.git

If you want only the latest version and not the full repository run

sh git clone --depth=1 https://github.com/irfu/irfu-matlab.git

Any time you want to update the code to the latest version, run from the command line

sh git pull

If you do not use command line there are github programs for Windows and Mac, see github web page.

Development install

This section is mostly for those of you who intend to develop and contribute code yourself (i.e. git push) and not just use 'irfu-matlab'.

It is recommended you first add SSH keys to your github.com account, please see github web pages for details on how to add an SSH key to your account. And then, when SSH keys have been configured, instead of cloning using the basic https:// command above instead from the command line run

sh git clone ssh://git@github.com/irfu/irfu-matlab.git

Then finally before actually contributing code, please have a look at our contributing guidelines.

Usage

Each time starting new Matlab session execute in Matlab:

matlab irf

To see help execute in Matlab

matlab help irfu-matlab

To test an example execute in Matlab:

matlab Example_1

this should download Cluster data from the CSA archive and plot the figure consisting of 5 panels with data from different instruments.

Issues

If you experience any issues with irfu-matlab please submit an issue via our github page.

When submitting a new issue, please provide information required to replicate the issue as well as information regarding operating system and version of Matlab used.

Owner

  • Name: Swedish Institute of Space Physics
  • Login: irfu
  • Kind: organization
  • Location: Uppsala

Citation (CITATION.cff) 

# This CITATION.cff file was generated with cffinit.
# See https://citation-file-format.github.io/

cff-version: 1.2.0
title: "IRFU-Matlab"
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
# Note listed here are the authors and contributors of IRFU-Matlab,
# ordered by number of commits at one historic point in time.
# (That is to say, the order is not strictly updated and enforced as things evolve).
#
# A lot of people have contributed over the years,
# (from start back in 2003-09-10T14:38:26Z), so any and all possibly unknown persons,
# contributing to IRFU-Matlab, are also included in '-name "IRFU-Matlab team"'.
authors:
  - family-names: "Khotyaintsev"
    given-names: "Yuri"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0001-5550-3113"
  - family-names: "Nilsson"
    given-names: "Thomas"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0001-9604-6377"
  - family-names: "Johansson"
    given-names: "Erik P. G."
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0001-9386-8148"
  - family-names: "Vaivads"
    given-names: "Andris"
    orcid: "https://orcid.org/0000-0003-1654-841X"
  - family-names: "Graham"
    given-names: "Daniel"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0002-1046-746X"
  - family-names: "Karlsson"
    given-names: "Jan"
    affiliation: "Swedish Institute of Space Physics"
  - family-names: "Cully"
    given-names: "Chris"
    orcid: "https://orcid.org/0000-0001-7242-8872"
  - family-names: "Norgren"
    given-names: "Cecilia"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0002-6561-2337"
  - family-names: "Johlander"
    given-names: "Andreas"
    orcid: "https://orcid.org/0000-0001-7714-1870"
  - family-names: "Li"
    given-names: "Wenya"
    affiliation: "National Space Science Center"
    orcid: "https://orcid.org/0000-0003-1920-2406"
  - family-names: "Eriksson"
    given-names: "Elin"
    orcid: "https://orcid.org/0000-0003-4040-9663"
  - family-names: "Dimmock"
    given-names: "Andrew"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0003-1589-6711"
  - family-names: "Steinvall"
    given-names: "Konrad"
    orcid: "https://orcid.org/0000-0002-5861-1643"
  - family-names: "Mella"
    given-names: "Meghan"
  - family-names: "Tigik"
    given-names: "Sabrina Ferrão"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0002-5968-9637"
  - family-names: "Boldu"
    given-names: "Jordi"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0002-0379-9335"
  - family-names: "Lundberg"
    given-names: "Mikael"
  - family-names: "Lindqvist"
    given-names: "Per-Arne"
    affiliation: "KTH Royal Institute of Technology"
    orcid: "https://orcid.org/0000-0001-5617-9765"
  - family-names: "Lalti"
    given-names: "Ahmad"
    affiliation: "Swedish Institute of Space Physics"
    orcid: "https://orcid.org/0000-0001-8532-3076"
  - family-names: "Fu"
    given-names: "Huishan"
    orcid: "https://orcid.org/0000-0002-4701-7219"
  - family-names: "Sundkvist"
    given-names: "David"
    orcid: "https://orcid.org/0000-0003-2794-7926"
  - family-names: "Yordanova"
    given-names: "Emiliya"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0002-9707-3147"
  - family-names: "Chasapis"
    given-names: "Alexandros"
    affiliation: "Laboratory for Atmospheric and Space Physics"
    orcid: "https://orcid.org/0000-0001-8478-5797"
  - family-names: "Retinò"
    given-names: "Alessandro"
    orcid: "https://orcid.org/0000-0001-5824-2852"
  - family-names: "Raptis"
    given-names: "Savvas"
    affiliation: "Johns Hopkins University Applied Physics Laboratory"
    orcid: "https://orcid.org/0000-0002-4381-3197"
  - family-names: "Toledo-Redondo"
    given-names: "Sergio"
    orcid: "https://orcid.org/0000-0002-4459-8783"
  - family-names: "Edberg"
    given-names: "Niklas"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0002-1261-7580"
  - family-names: "Eriksson"
    given-names: "Anders I."
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0000-0003-2926-6761"
  - family-names: "Benko"
    given-names: "Ilona"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
    orcid: "https://orcid.org/0009-0006-5627-3675"
  - family-names: "Spjuth"
    given-names: "Sofie"
  - family-names: "Thulstrup"
    given-names: "Paul"
  - family-names: "Wiberg"
    given-names: "Henrik"
  - family-names: "Lindberg"
    given-names: "Martin"
    orcid: "https://orcid.org/0000-0001-6342-225X"
  - family-names: "White"
    given-names: "Jack"
    affiliation: "Swedish Institute of Space Physics"
    city: "Uppsala"
  - name: "IRFU-Matlab team"
repository-code: "https://github.com/irfu/irfu-matlab"
doi: "10.5281/zenodo.11550090"

GitHub Events

Total
  • Create event: 12
  • Release event: 1
  • Issues event: 6
  • Watch event: 9
  • Delete event: 9
  • Issue comment event: 16
  • Push event: 164
  • Pull request event: 18
  • Fork event: 1
Last Year
  • Create event: 12
  • Release event: 1
  • Issues event: 6
  • Watch event: 9
  • Delete event: 9
  • Issue comment event: 16
  • Push event: 164
  • Pull request event: 18
  • Fork event: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 2
  • Total pull requests: 8
  • Average time to close issues: 1 day
  • Average time to close pull requests: 3 days
  • Total issue authors: 2
  • Total pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.63
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 8
Past Year
  • Issues: 2
  • Pull requests: 8
  • Average time to close issues: 1 day
  • Average time to close pull requests: 3 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 1.0
  • Average comments per pull request: 0.63
  • Merged pull requests: 7
  • Bot issues: 0
  • Bot pull requests: 8
View more stats
Top Authors
Issue Authors
  • ErikPGJ (10)
  • Sibghat46 (1)
  • thomas-nilsson-irfu (1)
  • Neetasha1111 (1)
  • ChaoGai72 (1)
  • neetasha (1)
  • shubhangilagad (1)
Pull Request Authors
  • dependabot[bot] (18)
  • pre-commit-ci[bot] (1)
Top Labels
Issue Labels
BICAS (7) enhancement (4) bug (2)
Pull Request Labels
dependencies (18) java (13) github_actions (5)

Packages

  • Total packages: 1
  • Total downloads: unknown
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 69
proxy.golang.org: github.com/irfu/irfu-matlab
  • Versions: 69
  • Dependent Packages: 0
  • Dependent Repositories: 0
Rankings
Dependent packages count: 5.6%
Average: 5.8%
Dependent repos count: 6.0%
Last synced: 6 months ago

Dependencies

.github/pom.xml maven
  • com.github.irfu:whamp 1.4.1
  • com.github.prbem:IRBEM 4.4.0
  • org.xerial:sqlite-jdbc 3.36.0.2
.github/workflows/ci-build.yml actions
  • actions/checkout v3 composite
  • actions/upload-artifact v3 composite
  • matlab-actions/run-command v1 composite
  • matlab-actions/setup-matlab v1 composite