Skip to content

Latest commit

 

History

History
163 lines (122 loc) · 7.36 KB

README.md

File metadata and controls

163 lines (122 loc) · 7.36 KB
Raw
pyowc logo pyowc is a python library for OWC salinity calibration in Python

Status Python Gitter
codecov build

This software is a python implementation of the "OWC" salinity calibration method used in Argo floats Delayed Mode Quality Control.

Post an issue to get involved if you're interested.

Installation

If you are using Linux, Windows or macOS, you can simply install this package using pip in a virtual environment. Assuming your virtual environment is activated:

pip install git+https://github.com/euroargodev/argodmqc_owc

Software usage

A short tutorial is available on the argopy documentation here.

For Python beginners, you can run the pyowc in this way:

In start_with_pycharm.py code, you can specify the WMO float number that you want to do analysis. You can also add more float numbers, then the calculations of all floats will be done at the same time.

import pyowc as owc

warnings.filterwarnings("ignore", category=RuntimeWarning)

if __name__ == '__main__':

    FLOAT_NAMES = ["3901960"]  # add float names here e.g. ["3901960","3901961","3901962"]
    USER_CONFIG = owc.configuration.load()  # fetch the default configuration and parameters
    print(owc.configuration.print_cfg(USER_CONFIG))

Parameters for your analysis

Parameters for the analysis are set in a configuration.py python code. The configuration has the same parameters as the Matlab software (https://github.com/ArgoDMQC/matlab_owc).

  • You can change the default directories to locations of your historical data.
        #    Climatology Data Input Paths
        'HISTORICAL_DIRECTORY': "data/climatology/"
        'HISTORICAL_CTD_PREFIX': "/historical_ctd/ctd_"
        'HISTORICAL_BOTTLE_PREFIX': "/historical_bot/bot_"
        'HISTORICAL_ARGO_PREFIX': "/historical_argo/argo_"
  • To run the analysis,you need to have the float source file in .mat format.
        #    Float Input Path
        'FLOAT_SOURCE_DIRECTORY': "data/float_source/"
        'FLOAT_SOURCE_POSTFIX': ".mat"
  • The output from the analysis will be saved in default directory of the code.You can change the default directories to locations of your constants.
        #    Constants File Path
        'CONFIG_DIRECTORY': "data/constants/"
        'CONFIG_COASTLINES': "coastdat.mat"
        'CONFIG_WMO_BOXES': "wmo_boxes.mat"
        'CONFIG_SAF': "TypicalProfileAroundSAF.mat"
  • Final step is to set your objective mapping parameters, e.g.
        'MAP_USE_PV': 0
        'MAP_USE_SAF': 0

        'MAPSCALE_LONGITUDE_LARGE': 8
        'MAPSCALE_LONGITUDE_SMALL': 4
        'MAPSCALE_LATITUDE_LARGE': 4
        'MAPSCALE_LATITUDE_SMALL': 2
  • Additionally, you can set a specific ranges of theta bounds for salinity anomaly plot. The code will crete two separate plots with set ranges.
     #    Plotting Parameters
        # Theta bounds for salinity anomaly plot
        'THETA_BOUNDS': [[0, 5], [5, 20]]

Plots

The plots are automatically generated. It is worth to note that only one plot will be displayed at one time in the PyCharm. The next plot will be displayed after closing the window of the current plot.

The number of generated plots at specific theta levels (from 1 to 10 theta levels) can be currently changed in the dashboard.py code. The default is set to 2. The plots will be generated separately for each theta level.

def plot_diagnostics(float_dir, float_name, config, levels=2):

Building the documentation

If you wish to build the documentation locally, you will need a virtual environment. Assuming your virtual environment is activated, follow these steps:

  1. Install the required documentation packages 
    pip install -r requirements-docs.txt
  2. Change directory to the docs directory, for example on Linux: 
    cd docs
  3. Run the sphinx-build command: 
    sphinx-build -M html source build -W

This will build the HTML documentation under the docs/build/html directory and can be viewed using your normal web browser.

:class: note

If you make modifications to the code or documentation configuration, you may need to delete
the `docs/source/generated` directory for the documentation to build correctly.

Software history

New positioning of functions

Note that functions name are not changed !

  • pyowc/core

    • stats.py: brk_pt_fit, build_cov, covarxy_pv, covar_xyt_pv, noise_variance, signal_variance, fit_cond, nlbpfun
    • finders.py: find_10thetas, find_25boxes, find_besthit, find_ellipse, nearest_neighbour

  • pyowc/data

    • fetchers.py: get_region_data, get_region_hist_locations, get_data, get_topo_grid, frontal_constraint_saf
    • wrangling.py: interp_climatology, map_data_grid

  • pyowc/plot

    • dashboard.py: plot_diagnostics
    • plots.py: cal_sal_curve_plot, sal_var_plot, t_s_profile_plot, theta_sal_plot, trajectory_plot
    • utils.py: create_dataframe

  • pyowc/calibration.py: update_salinity_mapping, calc_piecewisefit

  • pyowc/configuration.py: load_configuration, set_calseries, print_cfg

  • pyowc/tests # Contain all the unit tests !

  • pyowc/utilities.py: change_dates, cal2dec, potential_vorticity, wrap_longitudes, sorter, spatial_correlation