Skip to content

Commit

Permalink
Add DOI in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
zhihua-zheng authored Aug 17, 2020
1 parent bc9b83c commit fb7401f
Showing 1 changed file with 10 additions and 22 deletions.
32 changes: 10 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.??.svg)](https://doi.org/10.5281/zenodo.??)
[![DOI](https://zenodo.org/badge/287464756.svg)](https://zenodo.org/badge/latestdoi/287464756)

**This repository contains the MATLAB scripts used in the paper "Evaluating Monin-Obukhov scaling in unstable oceanic surface layer"**
**This repository contains the MATLAB scripts used in the paper "Evaluating Monin-Obukhov scaling in the unstable oceanic surface layer"**

You can reach me at [[email protected]](mailto:[email protected]) for questions related to the usage of this code.

### Description
This set of scripts fufills the analysis presented in the paper in three steps:
This set of scripts fufills the analysis presented in our paper in three steps:
- Load and process original data
- Calculate key parameters
- Produce figures
Expand All @@ -19,12 +19,12 @@ It also uses some external toolboxes/functions, as listed below:
- [cbrewer](https://www.mathworks.com/matlabcentral/fileexchange/34087-cbrewer-colorbrewer-schemes-for-matlab)
- [Custom Colormap](https://www.mathworks.com/matlabcentral/fileexchange/69470-custom-colormap)
- [RGB](https://www.mathworks.com/matlabcentral/fileexchange/24497-rgb-triple-of-color-name-version-2)
- [Marke​rTransparency](https://www.mathworks.com/matlabcentral/fileexchange/65194-peterrochford-markertransparency)
- [MarkerTransparency](https://www.mathworks.com/matlabcentral/fileexchange/65194-peterrochford-markertransparency)
- [suplabel](https://www.mathworks.com/matlabcentral/fileexchange/7772-suplabel)
- [tight_subplot](https://www.mathworks.com/matlabcentral/fileexchange/27991-tight_subplot-nh-nw-gap-marg_h-marg_w)

### Data
The data used in this work are mostly publicly available (see the "Data availability statement" in our paper). For your convience, a copy of the original data can be downloaded either from [this Google Drive link](https://drive.google.com/file/d/13UYYOT9AXFufjMw6_wr4-hoNv7M3tT7v/view?usp=sharing), or from the most recent [release]() of this repository.
The data used in this work are mostly publicly available (see the "Data availability statement" in our paper). For convience, a copy of the original data can be downloaded either from [this Google Drive link](https://drive.google.com/file/d/13UYYOT9AXFufjMw6_wr4-hoNv7M3tT7v/view?usp=sharing), or from the most recent [release](https://github.com/zhihua-zheng/EvaMO_UOSL_code/releases/tag/v1.0) of this repository.

### Work flow
1. Download this repository to your local computer. Alternatively, you can clone it using the command line in Terminal,
Expand All @@ -38,23 +38,11 @@ Add this repository to your MATLAB search path
addpath(genpath('<path to this repository>'))
```

2. Download the data file `EvaMO_UOSL_data.zip` as described in the [Data](#-data) section. Unzip it into the `EvaMO_UOSL_code` directory and rename the `EvaMO_UOSL_data` direcctory to `data`.
2. Download the data file `EvaMO_UOSL_data.zip` as described in the previous [Data](#-data) section. Unzip it into the `EvaMO_UOSL_code` directory.

3.
3. Run the main analysis script `evaMO_main.m`.

4.
### Attribution
This code is freely available for reuse as described in the MIT License. However, if you use this code in an academic publication, a propriate citation to the source would be appreciated:



Functions for solving super-equilibirum model equations are in ./library
========================================================================

Figures are generated by script 'evaMO_main.m'.
Please adjust the paths to the related data on your machine.

...

Fig. 8: Kansas-Obs-Model phi comparison
use data 'ocsp_pzData.mat' & 'spursi_pzData.mat'

...
* Zhihua Zheng. (2020, August 17). Analysis scripts for "Evaluating Monin-Obukhov scaling in the unstable oceanic surface layer" (Version v1.0). Zenodo. doi:10.5281/zenodo.3988503

0 comments on commit fb7401f

Please sign in to comment.