GEOMODELS-CLI(1)

NAME
geomodels-cli

SYNOPSIS
geomodels-cli [-h] [--version] [--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [-q] [-v] [--debug] {info,install-data,import-igrf} ...

DESCRIPTION
Command Line Interface (CLI) for the geomodels Python package.

OPTIONS

--version
    show program's version number and exit

--loglevel {DEBUG,INFO,WARNING,ERROR,CRITICAL}
    logging level (default: WARNING)

-q, --quiet
    suppress standard output messages, only errors are printed to screen (set "loglevel" to "ERROR")

-v, --verbose
    print verbose output messages (set "loglevel" to "INFO")

--debug
    print debug messages (set "loglevel" to "DEBUG")

SUB-COMMANDS

geomodels-cli info
    Provide information about the installation and environment.

geomodels-cli install-data
    Download and install the data necessary for models computation.

geomodels-cli import-igrf
    Import magnetic field data from IGRF text format.

COMMAND 'geomodels-cli info'
usage: geomodels-cli info [-h] [-d DATADIR] [-a] [--data] Provide information about the installation and environment.
    Information provided include: the platform, the library versions and
    installed data.

OPTIONS 'geomodels-cli info'

-d DATADIR, --datadir DATADIR
    specifies where the model data are stored.

-a, --all
    show both versions and platform info and also information about installed data

--data
    show info about installed data

COMMAND 'geomodels-cli install-data'
usage: geomodels-cli install-data [-h] [-b BASE_URL] [-d DATADIR]
                        [--no-progress]
                        {all,minimal,recommended,geoids,gravity,magnetic,egm84-30,egm84-15,egm96-15,egm96-5,egm2008-5,egm2008-2_5,egm2008-1,egm84,egm96,egm2008,grs80,wgs84,wmm2010,wmm2015,wmm2015v2,wmm2020,wmm2025,wmmhr2025,igrf11,igrf12,igrf13,igrf14,emm2010,emm2015,emm2017} Download and install the data necessary for models computation.
    GeoModels uses external data to perform geoid, gravity and magnetic
    field computations.
    It is possible to install different subsets of data:
    :minimal:
        only data for the default model of each kind (geoid,
        gravity and magnetic field) are installed,
    :recommended:
        install the `minimal` set of data (see above) plus few
        additional and commonly used data (it is guaranteed that
        the `recommended` subset always includes all data that
        are necessary to run the test suite),
    :all:
        install all available data (about 670MB of disk space
        required),
    :geoids:
        install data for all supported geoids,
    :gravity:
        install data for all supported gravity models,
    :magnetic:
        install data for all supported magnetic field models.
    Additionally the it is possible to install data for a single model.

{all,minimal,recommended,geoids,gravity,magnetic,egm84-30,egm84-15,egm96-15,egm96-5,egm2008-5,egm2008-2_5,egm2008-1,egm84,egm96,egm2008,grs80,wgs84,wmm2010,wmm2015,wmm2015v2,wmm2020,wmm2025,wmmhr2025,igrf11,igrf12,igrf13,igrf14,emm2010,emm2015,emm2017}
    model(s) to be installed

OPTIONS 'geomodels-cli install-data'

-b BASE_URL, --base-url BASE_URL
    specifies the base URL for the download (default: https://downloads.sourceforge.net/project/geographiclib).

-d DATADIR, --datadir DATADIR
    specifies where the datasets should be stored.

--no-progress
    suppress progress bar display

COMMAND 'geomodels-cli import-igrf'
usage: geomodels-cli import-igrf [-h] [-o OUTPATH] [--force] path Import magnetic field data from IGRF text format.
    Import Spherical Harmonics coefficients for the IGRF magnetic field
    model from text file in IGRF standard format.
    See: https://www.ngdc.noaa.gov/IAGA/vmod/igrf.html.

path
    path or URL of the IGRF text file

OPTIONS 'geomodels-cli import-igrf'

-o OUTPATH, --outpath OUTPATH
    specifies the output data path.

--force
    overwrite existing files (default: False).

AUTHOR
Antonio Valentino
antonio dot valentino at tiscali.it

DISTRIBUTION
The latest version of geomodels may be downloaded from https://github.com/avalentino/geomodels