pygmt.x2sys_init

pygmt.x2sys_init(tag, **kwargs)[source]

Initialize a new x2sys track database.

x2sys_init is the starting point for anyone wishing to use x2sys; it initializes a set of data bases that are particular to one kind of track data. These data, their associated data bases, and key parameters are given a short-hand notation called an x2sys TAG. The TAG keeps track of settings such as file format, whether the data are geographic or not, and the binning resolution for track indices.

Before you can run x2sys_init you must set the environmental parameter X2SYS_HOME to a directory where you have write permission, which is where x2sys can keep track of your settings.

Full option list at https://docs.generic-mapping-tools.org/latest/supplements/x2sys/x2sys_init.html

Aliases:

  • D = fmtfile

  • F = force

  • V = verbose

Parameters

  • tag (str) – The unique name of this data type x2sys TAG.

  • fmtfile (str) –

    Format definition file prefix for this data set [See Format Definition Files for more information]. Specify full path if the file is not in the current directory.

    Some file formats already have definition files premade. These include:

    • mgd77 (for plain ASCII MGD77 data files)

    • mgd77+ (for enhanced MGD77+ netCDF files)

    • gmt (for old mgg supplement binary files)

    • xy (for plain ASCII x, y tables)

    • xyz (same, with one z-column)

    • geo (for plain ASCII longitude, latitude files)

    • geoz (same, with one z-column).

  • verbose (str) – Select verbosity level [Default is w], which modulates the messages written to stderr. Choose among 7 levels of verbosity: ‘q’ - Quiet, not even fatal error messages are produced; ‘e’ - Error messages only; ‘w’ - Warnings [Default]; ‘t’ - Timings (report runtimes for time-intensive algorithms); ‘i’ - Informational messages (same as verbose=True); ‘c’ - Compatibility warnings; ‘d’ - Debugging messages.