The MODAAT console utility

Context

The MODAAT console utility is a small experimental program making possible to explore datasets and obtain data from our climate data server using only a simple computer terminal. The technology used to interface with the ERDDAP server is erddapy. The MODAAT console utility integrate erddapy to navigate efficiently through the datasets served on our ERDDAP server. The console utility was developed as a proof-of-concept to rapidly get the data a researcher need, without clicking around and with a minimum of typing on the keyboard. This project is still in its early stages and is ongoing.

Overview

Index

  1. Getting started
  2. To install using Linux/MacOSX
  3. To install using Windows
  4. Using the application
  5. What next?

1. Getting started

This program purpose is to connect and interact, using a console, an instance of an ERDDAP server with the OPeNDAP protocol to browse the available climatic data hosted on the server.

This is as a proof of concept for MODAAT as a Use Case within the CCADI project.

Presently, the program connect to the project ERDDAP server at the Centre d’Études Nordiques (CEN) at Université Laval.

2. To install using Linux/MacOSX

Prerequisite: a working Python 3.10 +.

Python version can be verified as follows from a terminal. For example:

                    
                        $ python -V
                        Python 3.10.2
                        $
                    
                

Python can be obtained here.

                    
                        $ python -m venv venv
                        $ source venv/bin/activate
                        $ (venv) pip install modaat-console
                    
                

To run

                    
                        $ (venv) modaat_console
                    
                

3. To install using Windows

Prerequisite: a working Python 3.10 +

Python version can be verified as follows from a terminal. For example:

                    
                        c:\users\anyusers> python -V
                        Python 3.10.2
                        c:\users\anyusers>
                    
                

Python can be obtained here.

                    
                        c:\users\anyusers> python -m venv venv
                        c:\users\anyusers> venv\Scripts\activate.bat
                        (venv) c:\users\anyusers> pip install modaat-console
                    
                

To run

                    
                        $(venv) c:\users\anyusers> modaat_console
                    
                

4. Using the application

When starting the application, the program connect to the dataset server and list how many datasets are available to work with. After it present options to explore the datasets, as follows:

  1. List all available datasets
  2. Search a string in the ERDDAP
  3. Select a dataset to explore
  4. Print all variables in dataset
  5. Print all attributes in dataset
  6. Print dataset axis labels
  7. Print sample dataset
  8. Get the whole dataset
  9. Exit

The ideal workflow involve first to decide with which dataset one need to work with. Suggested steps are:

  1. List which datasets are available to have an idea which one may be of interest or;
  2. Search for a string or a keyword (ex: water, glacier, region, feature name)

Then, one select which dataset to explore in depth using option 3. One it is selected, it will show in the prompt - it will stay selected until one change for another using the same option or restarting the program.

Afterward one may print variables, attributes, axis and even a sample of the dataset (first few days). Selecting Get the whole dataset will provide a clickable link to download locally a csv formatted file.

Once done, one may exit, or select a new dataset using option 3.

5. What next?

Several features are currently being developed: for example:

  1. A date to date function to subsample the full dataset.
  2. Improvement to the rendering (output) of the various queries.
  3. Improvement to make the tool work with other ERDDAP server.