Usage
=====================================================================================

tiegcmpy can be run in two modes: API and Command Line Interface (CLI).

Mode: API
-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

tiegcmpy can be used in custom Python scripts or Jupyter notebooks.

Importing tiegcmpy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: python

    import tiegcmpy as ty

Loading Datasets
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Loading a dataset/datasets:

  .. note::

      For the inbuilt plotting routines only this method can be used to load the NetCDF datasets.


  .. code-block:: python

      ty.load_datasets(directory/file, dataset_filter)


Plot Generation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The following plots can be made with tiegcmpy:

- Latitude vs Longitude plots
- Pressure level vs Variable Value plots
- Pressure level vs Longitude plots
- Pressure level vs Latitude plots
- Pressure level vs Time plots
- Latitude vs Time plots

Examples and detailed usage can be found in the Functionality section.

Mode: CLI
-------------------------------------------------------------------------------------------------------

TIEGCMy can also be used directly from the command line. The following plots can be made on the command line:

- Latitude vs Longitude plots
- Pressure level vs Variable Value plots
- Pressure level vs Longitude plots
- Pressure level vs Latitude plots
- Pressure level vs Time plots
- Latitude vs Time plots

Examples and detailed usage can be found in the plotting routines section.