Skip to content

A MATLAB MEX wrapper for the International Reference Ionosphere 2020 Model

Notifications You must be signed in to change notification settings

breid-phys/mexIRI2020

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

4 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

A MATLAB MEX wrapper for the International Reference Ionosphere Model

A MEX file allows users to execute FORTRAN code from within MATLAB.
This repository adds three MATLAB functions, one to interface with the MEX code, 
the other two to automatically download the apf107.dat and ig_rz.dat files to provide 
needed indices to the IRI MSIS. 

IRI2020.m should automatically compile a MEX file when first run.

By default, the IRI will be configured as the default specific in IRISUB.F.

See IRI2020.m for details.	
		
NOTE: The Fortran code in IRIFUN.F, IGRF.F, CIRA.F have been modified to remove
instances of the STOP statement. This statement tends to produce unpredictable 
behaviour in MATLAB when called in a MEX file, up to and including killing all 
active MATLAB instances. Care should be taken when updating the IRI code.
		
		International Reference Ionosphere Software (Aug 5, 2022)
		----------------------------------------------------------

================================================================================

The IRI is a joined project of the Committee on Space Research (COSPAR) and the 
International Union of Radio Science (URSI). IRI is an empirical model specifying
monthly averages of electron density, ion composition, electron temperature, and 
ion temperature in the altitude range from 50 km to 1500 km.

This directory includes the FORTRAN program, coefficients, and indices files for 
the latest version of the International Reference Ionosphere model: IRI2012. This
version includes several options for different parts and parameters. A logical
array JF(30) is used to set these options. The IRI-recommended set of options
can be found in the COMMENT section at the beginning of IRISUB.FOR. IRITEST.FOR 
sets these options as the default.

The compilation/link command in Fortran 77 is:
f77 -o iri iritest.for irisub.for irifun.for iritec.for iridreg.for igrf.for 
 cira.for iriflip.for rocdrift.for
 
Directory Contents:
-----------------------------------------------------------------------------------

00_iri.tar		TAR file that includes all files from this directory and that was 
                created in UNIX using 'tar -cvf 00_iri.tar *'. UNIX command to 
                unpack is "tar -xvf 00_iri.tar". 
				 
irisub.for      This file contains the main subroutine iri_sub. It computes 
                height profiles if IRI output parameters (Ne, Te, Ti, Ni, vi) 
                for specified date and location. Also included is the 
                subroutine iri_web that computes output parameters versus
                latitude, longitude (geog. or geom.), year, day of year, hour 
                (LT or UT), and month. An example of how to call and use iri_web 
                is shown in iritest.for. Compilation of iritest.for requires
                irisub.for, irifun.for, iritec.for, iridreg.for, igrf.for, and
                cira.for.

irifun.for      This file contains the subroutines and functions that are 
                required for running IRI.


iriflip.for     Subroutines for the FLIP-related new model for the bottomside
                ion composition of Richards et al.
                
iridreg.for     Subroutines for the D region models of Friedrich-Torkar
                and of Danilov et al.

iritec.for      This file includes the subroutines for computing the ionospheric 
                electron content from 60km up to a specified upper limit. 

rocdrift.for    Equatorial vertical ion drift model of Fejer et al. (2009)

cira.for        This file includes the subroutines and functions for computing 
                the COSPAR International Reference Ionosphere (NRLMSIS-00) 
                neutral temperature and densities. 

igrf.for        This file includes the subroutines for the International
                Geomagnetic Reference Field (IGRF).

dgrf%%%%.dat    Definitive IGRF coefficients for the years 1945 to 2010 in steps
                of 5 years (%%%%=1945, 1950, etc.)(ASCII).
igrf%%%%.dat    Prelimenary IGRF coefficients for most recent year (ASCII).
igrf%%%%s.dat   IGRF coefficients for extrapolating 5 years into the future (ASCII).
 
MCSAT%%.dat     Monthly coefficient files for the Shubin(2015) COSMIC-based hmF2 model
                %%=month+10
                
iritest.for     Test program indicating how to use of the IRI subroutines. 
                Requires irisub, irifun, iritec, iridreg, igrf,and cira.
                
IN ADDITION THE FOLLOWING COEFFICIENTS AND INDICES FILES ARE REQUIRED THAT ARE NOT INCLUDED IN THIS DIRECTORY. THESE FILES ARE AVAILABLE ON THE IRI HOMEPAGE IRIMODEL.ORG:

Indices files at http://irimodel.org/indices/:
ig_rz.dat       This file(s) contains the solar and ionospheric indices (IG12, Rz12) 
                for the time period from Jan 1958 onward. The file is updated 
                quarterly. It is read by subroutine tcon in irifun.for (ASCII). 
                [This file will be updated at close to quarterly intervals]                
apf107.dat      This file provides the 3-hour ap magnetic index and F10.7 daily
                81-day and 365-day index from 1960 onward (ASCII).
                [This file will be updated at close to quarterly intervals]
Daily updates of these two files are available from the ECHAIM website (David 
Themens) as described on irimodel.org.

Coefficients files at http://irimodel.org/COMMON_FILES/:
CCIR%%.dat		Monthly coefficient files for the CCIR foF2 and M(3000)F2 models
                %%=month+10
URSI%%.dat		Monthly coefficient files for the URSI foF2 model
                %%=month+10

-----------------------------------------------------------------------------------
-----------------------------------------------------------------------------------

NOTE: Please consult the 'listing of changes' in the comments section at the top 
of each one of these programs for recent corrections and improvements.

More information about the IRI project can be found at irimodel.org including
access to sites that allow online computation and plotting of IRI parameters. 

The IRI output parameters are described at irimodel.org/IRI-output-arrays.docs
The available options are described at irimodel.org/IRI-Switches-options.docs
Answers to Frequently Asked Questions are available at irimodel.org/docs/IRI_FAQ.pdf

----------------------------- dbilitza@gmu.edu -------------------------------------

About

A MATLAB MEX wrapper for the International Reference Ionosphere 2020 Model

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published