Skip to content

Commit 87467a3

Browse files
committed
add license file and adjust the license information in the files accordingly
1 parent 957fe26 commit 87467a3

10 files changed

+786
-30
lines changed

LICENSE

+661
Large diffs are not rendered by default.

README.md

+21-9
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Recurrence plot & Quantification #
2-
1+
# Recurrence plot & Quantification #
2+
33
Simple MATLAB functions for calculating recurrence plots and recurrence quantification.
4-
5-
4+
5+
66
## Functions
77

88
### embed
@@ -136,12 +136,24 @@ Y = rqa(R);
136136

137137
## Application
138138

139-
Trauth et al, Classifying past climate change in the Chew Bahir basin, southern Ethiopia, using recurrence quantification analysis, *Climate Dynamics*, in press, 2019
139+
Part of this code was used in the study
140+
141+
* M. H. Trauth, A. Asrat, W. Duesing, V. Foerster, K. H. Kraemer, N. Marwan, M. A. Maslin, F. Schaebitz: _Classifying past climate change in the Chew Bahir basin, southern Ethiopia, using recurrence quantification analysis_, Climate Dynamics, 53(5), 2557–2572 (2019). DOI:[10.1007/s00382-019-04641-3](https://doi.org/10.1007/s00382-019-04641-3)
140142

141-
## How to cite
142-
143-
* Zenodo?
143+
## How to cite
144+
145+
* Zenodo link
144146

145147
## Background
146148

147-
http://www.recurrence-plot.tk/
149+
read more about recurrence plot analysis at
150+
<http://www.recurrence-plot.tk/>
151+
152+
## License
153+
154+
(see LICENSE file)
155+
156+
Copyright 2016-2020,
157+
Potsdam Institute for Climate Impact Research (PIK),
158+
Institute of Geosciences, University of Potsdam,
159+
K. Hauke Kraemer, Norbert Marwan, Martin H. Trauth

embed.m

+10-5
Original file line numberDiff line numberDiff line change
@@ -21,11 +21,16 @@
2121
% Norbert Marwan
2222
% http://www.pik-potsdam.de
2323
%
24-
% This program is free software; you can redistribute it and/or
25-
% modify it under the terms of the GNU General Public License
26-
% as published by the Free Software Foundation; either version 2
27-
% of the License, or any later version.
28-
24+
% This program is free software: you can redistribute it and/or modify it under the terms of the
25+
% GNU Affero General Public License as published by the Free Software Foundation, either
26+
% version 3 of the License, or (at your option) any later version.
27+
% This program is distributed in the hope that it will be useful, but WITHOUT ANY
28+
% WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
29+
% FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
30+
% details.
31+
% You should have received a copy of the GNU Affero General Public License along with this
32+
% program. If not, see <http://www.gnu.org/licenses/>.
33+
2934

3035
%% check input and output arguments
3136
narginchk(1,3)

example_isoRP.m

+17
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,22 @@
11
%% MATLAB Example for calculating perpendicular and iso-directional RP
22

3+
% Copyright (c) 2016-2019
4+
% Potsdam Institute for Climate Impact Research, Germany
5+
% Institute of Geosciences, University of Potsdam, Germany
6+
% Norbert Marwan, K. Hauke Kraemer
7+
% http://www.pik-potsdam.de
8+
%
9+
% This program is free software: you can redistribute it and/or modify it under the terms of the
10+
% GNU Affero General Public License as published by the Free Software Foundation, either
11+
% version 3 of the License, or (at your option) any later version.
12+
% This program is distributed in the hope that it will be useful, but WITHOUT ANY
13+
% WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
14+
% FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
15+
% details.
16+
% You should have received a copy of the GNU Affero General Public License along with this
17+
% program. If not, see <http://www.gnu.org/licenses/>.
18+
19+
320
%% calculate example system Lorenz
421
[t x] = ode45('lorenz',[0 200],rand(1,3));
522
%x = resample(x(10300:11000,:),4,1);

example_script.m

+11-6
Original file line numberDiff line numberDiff line change
@@ -16,13 +16,18 @@
1616
% Copyright (c) 2016-2019
1717
% Potsdam Institute for Climate Impact Research, Germany
1818
% Institute of Geosciences, University of Potsdam, Germany
19-
% Norbert Marwan, Hauke Kraemer, Martin H. Trauth
20-
% http://www.pik-potsdam.de and http://www.geo.uni-potsdam.de
19+
% Norbert Marwan, K. Hauke Kraemer, Martin H. Trauth
20+
% http://www.pik-potsdam.de
2121
%
22-
% This program is free software; you can redistribute it and/or modify it
23-
% under the terms of the GNU General Public License as published by the
24-
% Free Software Foundation; either version 2 of the License, or any later
25-
% version.
22+
% This program is free software: you can redistribute it and/or modify it under the terms of the
23+
% GNU Affero General Public License as published by the Free Software Foundation, either
24+
% version 3 of the License, or (at your option) any later version.
25+
% This program is distributed in the hope that it will be useful, but WITHOUT ANY
26+
% WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
27+
% FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
28+
% details.
29+
% You should have received a copy of the GNU Affero General Public License along with this
30+
% program. If not, see <http://www.gnu.org/licenses/>.
2631

2732
%%
2833
% Clear workspace, clear Command Window, close all Figure windows.

lorenz.m

+16
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,22 @@
66
% r = 210;
77
% [t x] = ode45('lorenz',[0 200],rand(1,3),[],r);
88

9+
% Copyright (c) 2016-2019
10+
% Potsdam Institute for Climate Impact Research, Germany
11+
% Institute of Geosciences, University of Potsdam, Germany
12+
% Norbert Marwan, K. Hauke Kraemer
13+
% http://www.pik-potsdam.de
14+
%
15+
% This program is free software: you can redistribute it and/or modify it under the terms of the
16+
% GNU Affero General Public License as published by the Free Software Foundation, either
17+
% version 3 of the License, or (at your option) any later version.
18+
% This program is distributed in the hope that it will be useful, but WITHOUT ANY
19+
% WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20+
% FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
21+
% details.
22+
% You should have received a copy of the GNU Affero General Public License along with this
23+
% program. If not, see <http://www.gnu.org/licenses/>.
24+
925
% parameter r
1026
if nargin<4
1127
r=28;

rp.m

+10-5
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,18 @@
4949
% Copyright (c) 2016-2019
5050
% Potsdam Institute for Climate Impact Research, Germany
5151
% Institute of Geosciences, University of Potsdam, Germany
52-
% Norbert Marwan, Hauke Kraemer
52+
% Norbert Marwan, K. Hauke Kraemer
5353
% http://www.pik-potsdam.de
5454
%
55-
% This program is free software; you can redistribute it and/or
56-
% modify it under the terms of the GNU General Public License
57-
% as published by the Free Software Foundation; either version 2
58-
% of the License, or any later version.
55+
% This program is free software: you can redistribute it and/or modify it under the terms of the
56+
% GNU Affero General Public License as published by the Free Software Foundation, either
57+
% version 3 of the License, or (at your option) any later version.
58+
% This program is distributed in the hope that it will be useful, but WITHOUT ANY
59+
% WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
60+
% FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
61+
% details.
62+
% You should have received a copy of the GNU Affero General Public License along with this
63+
% program. If not, see <http://www.gnu.org/licenses/>.
5964

6065

6166
%% check input

rp_iso.m

+14
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,20 @@
77
%
88
% R=RP_ISO(X,E,W,TAU) estimate tangential vector using time delay TAU.
99

10+
% Copyright (c) 2016-2019
11+
% Potsdam Institute for Climate Impact Research
12+
% K. Hauke Kraemer, Norbert Marwan
13+
% http://www.pik-potsdam.de
14+
%
15+
% This program is free software: you can redistribute it and/or modify it under the terms of the
16+
% GNU Affero General Public License as published by the Free Software Foundation, either
17+
% version 3 of the License, or (at your option) any later version.
18+
% This program is distributed in the hope that it will be useful, but WITHOUT ANY
19+
% WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20+
% FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
21+
% details.
22+
% You should have received a copy of the GNU Affero General Public License along with this
23+
% program. If not, see <http://www.gnu.org/licenses/>.
1024

1125
%% check input
1226
narginchk(1,5)

rp_perp.m

+16
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,22 @@
77
%
88
% R=RP_PERP(X,E,W,TAU) estimate tangential vector using time delay TAU.
99

10+
% Copyright (c) 2016-2019
11+
% Potsdam Institute for Climate Impact Research
12+
% K. Hauke Kraemer, Norbert Marwan
13+
% http://www.pik-potsdam.de
14+
%
15+
% This program is free software: you can redistribute it and/or modify it under the terms of the
16+
% GNU Affero General Public License as published by the Free Software Foundation, either
17+
% version 3 of the License, or (at your option) any later version.
18+
% This program is distributed in the hope that it will be useful, but WITHOUT ANY
19+
% WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
20+
% FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
21+
% details.
22+
% You should have received a copy of the GNU Affero General Public License along with this
23+
% program. If not, see <http://www.gnu.org/licenses/>.
24+
25+
1026
%% check input
1127
narginchk(1,5)
1228
nargoutchk(0,3)

rqa.m

+10-5
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,18 @@
3737
% Copyright (c) 2016-2019
3838
% Potsdam Institute for Climate Impact Research, Germany
3939
% Institute of Geosciences, University of Potsdam, Germany
40-
% Norbert Marwan, Hauke Kraemer
40+
% Norbert Marwan, K. Hauke Kraemer
4141
% http://www.pik-potsdam.de
4242
%
43-
% This program is free software; you can redistribute it and/or
44-
% modify it under the terms of the GNU General Public License
45-
% as published by the Free Software Foundation; either version 2
46-
% of the License, or any later version.
43+
% This program is free software: you can redistribute it and/or modify it under the terms of the
44+
% GNU Affero General Public License as published by the Free Software Foundation, either
45+
% version 3 of the License, or (at your option) any later version.
46+
% This program is distributed in the hope that it will be useful, but WITHOUT ANY
47+
% WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
48+
% FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
49+
% details.
50+
% You should have received a copy of the GNU Affero General Public License along with this
51+
% program. If not, see <http://www.gnu.org/licenses/>.
4752

4853
%% check input
4954
narginchk(1,3)

0 commit comments

Comments
 (0)