tiegcmpy 1.0.0

A Python3 post processing tool for TIE-GCM

TIEPY

Tiepy is a tool used for TIE-GCM post processing and plot generation.

Installation

Build tiepy using python

python setup.py sdist

Install the generated python pip distribution

pip install /dist/tiepy-X.X.X.tar.gz

Requrements

• Python >= 3.8.0
• Python pip >= 23.2.1
  • cartopy >= 0.21.1
  • numpy >= 1.24.4
  • matplotlib >= 3.7.2
  • xarray >= 2023.1.0

Usage

Tiepy can be run in two modes:

1. Mode: Single Plot

   Load database for generation of a single plot to a single file

2. Mode: Multiple Plot

   Load database for generation of multiple plots to a single or multiple files

Mode: Single Plot

Example:

tiepy --plot_type {plot_type} -dir {directory of datasets} --dataset_filter {primary or secondary files} --output_format {format of output plot} --[Other optional arguments for specific plots]

Mode: Multiple Plot

Option 1: Initiate Interactive mode to generate multiple plots from different datasets

tiepy -rec

Wait for the command input request.

Entering Interactive Mode
Enter command or 'exit' to terminate:

Type the arguments to request a plot with the dataset and output file information

--plot_type {plot_type} -dir {directory of datasets} --dataset_filter {primary or secondary files} --output_format {format of output plot} --[Other optional arguments for specific plots]

Wait for input request. Type another command or 'exit'

Option 2: Load dataset for multiple plot generation to multiple files

tiepy -rec -dir {directory of datasets} --dataset_filter {primary or secondary files} 

Loads datasets into memory and requests for input.

Entering Interactive Mode
Loading datasets globally.
Enter command or 'exit' to terminate: 

Type the arguments to request a plot with the output file information

--plot_type {plot_type} --output_format {format of output plot} --[Other optional arguments for specific plots]

Wait for input request. Type another command or 'exit'

Option 3: Load dataset for multiple plot generation to a single PDF file

tiepy -rec -dir {directory of datasets} --dataset_filter {primary or secondary files} --multiple_output {Output PDF file name}

Loads datasets into memory, generates the PDF file and requests for input.

Entering Interactive Mode
Loading datasets globally.
Enter command or 'exit' to terminate: 

Type the arguments to request a plot.

--plot_type {plot_type} --[Other optional arguments for specific plots]

Wait for input request. Type another command or 'exit'

License

"""License Information"""