Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/PRBEM/IRBEM/llms.txt

Use this file to discover all available pages before exploring further.

These routines query the compiled IRBEM shared library for version and configuration metadata. They are useful for logging the exact library state in scientific workflows, verifying reproducibility, and confirming which IGRF model epoch is baked into the build.

​
IRBEM_FORTRAN_VERSION

Returns the repository version number of the Fortran source code that was used to compile the library. 
INTEGER VERSN
call IRBEM_FORTRAN_VERSION1(VERSN)

​
Output

​
VERSN
integer
IRBEM Fortran source repository version number.

​
IRBEM_FORTRAN_RELEASE

Returns the release tag of the Fortran source code as a character array. This complements IRBEM_FORTRAN_VERSION by providing a human-readable label such as a Git tag or release name. 
CHARACTER(LEN=80) RLS
call IRBEM_FORTRAN_RELEASE1(RLS)
In IDL, string arguments must be defined as byte arrays before the call: rls = BYTARR(80). The returned bytes can then be converted to a string with STRING(rls).

​
Output

​
RLS
array of 80 characters
Release tag string of the compiled Fortran source (e.g. a Git tag or version label).

​
GET_IGRF_VERSION

Returns the version number of the International Geomagnetic Reference Field (IGRF) model that is compiled into the library. Different IGRF editions (e.g. IGRF-13, IGRF-14) use different coefficient sets; checking this value ensures your results are traceable to a specific model epoch. 
INTEGER igrf_version
call GET_IGRF_VERION_(igrf_version)
The Fortran entry-point name contains a deliberate typo inherited from the source: GET_IGRF_VERION_ (missing the S in VERSION). Use this exact spelling when calling the routine directly from Fortran or a C interface.

​
Output

​
IGRF_VERSION
integer
Version number of the IGRF model compiled into the library (e.g. 13 for IGRF-13).

​
GET_IRBEM_NTIME_MAX

Returns the size of the time dimension used for fixed-size input and output arrays in certain IRBEM routines. This constant is needed when pre-allocating arrays in Fortran or IDL before calling those routines. 
INTEGER ntime_max
call GET_IRBEM_NTIME_MAX1(ntime_max)
! Allocate output arrays accordingly, e.g.:
! REAL*8 Lstar(3, ntime_max)
In previous versions of IRBEM, NTIME_MAX was used extensively across most routines. Where the time dimension is the first dimension of an array, modern IRBEM routines now accept variable-length arrays of any size — you only need to ensure the array is large enough to hold ntime elements.NTIME_MAX is still explicitly required for routines where the time dimension is not the first dimension. Those routines call this out in their own documentation entries.

​
Output

​
NTIME_MAX
integer
Size of the time dimension used in fixed-size IRBEM input/output arrays.

Build docs developers (and LLMs) love

Get started for freeTalk to us