Skip to content

Commit f325abb

Browse files
committed
Minor updates to the readme
1 parent 255c95a commit f325abb

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ Please cite this work when using this model:
88

99
Anchukaitis, K.J., M.N. Evans, M. K. Hughes, and E. Vaganov, An interpreted language implementation of the Vaganov-Shashkin tree-ring proxy system model, *Dendrochronologia*, 60, 125677, doi:[10.1016/j.dendro.2020.125677](https://doi.org/10.1016/j.dendro.2020.125677), 2020
1010

11-
A preprint is available at [EartharXiv](https://doi.org/10.31223/osf.io/ruyad).
11+
A earlier preprint is still available at [EartharXiv](https://doi.org/10.31223/osf.io/ruyad).
1212

1313
Please inform Kevin Anchukaitis if you identify any bugs.
1414

1515
## Basic Applications
1616

17-
The code model function is `vsm`. This function runs both the Environmental and Growth blocks using daily temperature and precipitation input as well as latitude (for daylength calculations). The function call is:
17+
The core model function is `vsm`. This function runs both the Environmental and Growth blocks using daily temperature and precipitation input as well as latitude (for daylength calculations). The function call is:
1818

1919
```matlab
2020
[output] = vsm(T,P,phi,syear,eyear,parameters,varargin)
@@ -39,6 +39,8 @@ This repository comes with three demonstration files that recreate the figures i
3939

4040
The original FORTRAN model was developed for Northern Hemisphere applications. As a consequence the definition of a year in the model is from January 1st to December 31st, which is unlikely to be adequate for Southern Hemisphere tree-ring applications.
4141

42+
The original FORTRAN also had additional modules for calculating cell size and which could also be used to derive density-type metrics. This module has not be migrated to MATLAB.
43+
4244
## Octave Functionality
4345

4446
The core model function `vsm` works in Octave without modification (avoiding use of `nansum` and `nanmean` that are not part of core Octave distributions). Some of the demo scripts and the helper functions therein, however, use commands not available or with a different syntax in Octave and in general Octave (testing on version 4.4.1 running on a Macbook Pro with Darwin Kernel Version 17.7.0) was found to be substantially slower than the same operations in MATLAB.

0 commit comments

Comments
 (0)