Skip to content

CLI

OTSO.clean 

clean(*args, **kwargs)

Clean OTSO-generated files and temporary data.

Removes temporary files, cached data, and output files created by OTSO calculations to free up disk space and reset the working environment.

Usage

OTSO.clean()

Can also be used as CLI command: OTSO.clean

OTSO.addstation 

addstation(*args, **kwargs)

Add a new neutron monitor station to the OTSO database.

Registers a new station location for use in OTSO calculations. Useful when new neutron monitor stations are established or for adding custom locations with specific names for repeated use.

Parameters:

  • StationName (str) –

    Name identifier for the new station.

  • Latitude (float) –

    Geographic latitude in degrees.

  • Longitude (float) –

    Geographic longitude in degrees.

Usage

OTSO.addstation("NEWSTATION", 65.0, 25.0)

CLI usage

OTSO.addstation NEWSTATION 65.0 25.0

Note: If station already exists, you will have option to overwrite.

OTSO.removestation 

removestation(*args, **kwargs)

Remove a station from the OTSO database.

Deletes a station entry from the OTSO database. Useful for correcting incorrectly entered station data or removing obsolete stations.

Parameters:

  • StationName (str) –

    Name of station to remove.

Usage

OTSO.removestation("OLDSTATION")

CLI usage

OTSO.removestation OLDSTATION

OTSO.liststations 

liststations(*args, **kwargs)

List all available neutron monitor stations in the OTSO database.

Displays all currently registered stations with their coordinates. Useful for finding available station names and verifying station data.

Usage

OTSO.liststations()

CLI usage

OTSO.liststations

Returns:

  • –

    List of all available stations with coordinates.

OTSO.IGRFupdate 

IGRFupdate(*args, **kwargs)

CLI function to update the IGRF model data. Running this CLI function will download the latest IGRF coefficients from the official IGRF website and update the local OTSO database. You can specify older IGRF models by providing the desired model version as an argument (e.g., 13 for IGRF-13).

example usage

OTSO.IGRFupdate

OTSO.IGRFupdate 13