pyrqa/PKG-INFO at master · guilhermelia/pyrqa · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
Metadata-Version: 1.1
Name: PyRQA
Version: 0.1.0
Summary: A tool to conduct recurrence quantification analysis and tocreate recurrence plots in a massively parallel manner using the OpenCL framework.
Home-page: UNKNOWN
Author: Tobias Rawald
Author-email: tobias.rawald@gfz-potsdam.de
License: UNKNOWN
Description: General Information
        -------------------

        PyRQA is a tool to conduct recurrence quantification analysis (RQA) and to create recurrence plots in a massively parallel manner using the OpenCL framework.
        It is designed to process very long time series consisting of hundreds of thousands of data points efficiently.

        PyRQA supports the computation of the following RQA measures:

            - Recurrence Rate (RR)
            - Determinism (DET)
            - Average diagonal line length (L)
            - Longest diagonal line (L_max)
            - Divergence (DIV)
            - Entropy diagonal lines (L_entr)
            - Laminarity (LAM)
            - Trapping time (TT)
            - Longest vertical line (V_max)
            - Entropy vertical lines (V_entr)
            - Average white vertical line length (W)
            - Longest white vertical line (W_max)
            - Entropy white vertical lines (W_entr)

        In addition, PyRQA allows to compute the thresholded recurrence matrix as well as to save the corresponding recurrence plot as an image file.

        Install
        -------

        PyRQA can be installed via::

            $ pip install PyRQA

        Requirements
        ------------

        To run PyRQA on OpenCL devices (such as GPUs and CPUs), it may be required to install hardware vendor specific software, e.g., device drivers.
        Regarding the latest versions of MacOS X, OpenCL support should be available by default.

        Software and information regarding selected vendors can be found at:

            - AMD: http://developer.amd.com/tools-and-sdks/opencl-zone/
            - Intel: https://software.intel.com/en-us/articles/opencl-drivers
            - NVIDIA: https://developer.nvidia.com/opencl

        Usage
        -----

        RQA computations can be conducted using::

            >>> from pyrqa.settings import Settings
            >>> from pyrqa.neighbourhood import FixedRadius
            >>> from pyrqa.metric import EuclideanMetric
            >>> from pyrqa.computation import RQAComputation
            >>> time_series = [0.1, 0.5, 0.3, 1.7, 0.8, 2.4, 0.6, 1.2, 1.4, 2.1, 0.8]
            >>> settings = Settings(time_series,
                                    embedding_dimension=3,
                                    time_delay=1,
                                    neighbourhood=FixedRadius(1.0),
                                    similarity_measure=EuclideanMetric,
                                    theiler_corrector=1,
                                    min_diagonal_line_length=2,
                                    min_vertical_line_length=2,
                                    min_white_vertical_line_length=2)
            >>> computation = RQAComputation.create(settings, verbose=True)
            >>> result = computation.run()
            >>> print result

        Recurrence plot computations can be conducted likewise. Building on the previous example::

            >>> from pyrqa.computation import RecurrencePlotComputation
            >>> from pyrqa.image_generator import ImageGenerator
            >>> computation = RecurrencePlotComputation.create(settings)
            >>> result = computation.run()
            >>> ImageGenerator.save_recurrence_plot(result.recurrence_matrix_reverse, 'recurrence_plot.png')

        Moreover, it is possible to read time series data that is stored column-wise from a file, e.g.,::

            >>> from pyrqa.file_reader import FileReader
            >>> time_series = FileReader.file_as_float_array('data.csv',
                                                             delimiter=';',
                                                             column=0)

        The previous examples use the default OpenCL environment. To create a custom environment using command line input, use::

            >>> from pyrqa.opencl import OpenCL
            >>> opencl = OpenCL(command_line=True)

        In addition, the OpenCL platform as well as the computing devices can be selected using their IDs, e.g.::

            >>> opencl = OpenCL(platform_id=0, device_ids=(0,))

        To use the custom environment, replace the default OpenCL object, e.g.,::

            >>> computation.opencl = opencl

        or create a new computation object, e.g.,::

            >>> computation = RQAComputation.create(settings, opencl=opencl, verbose=True)

        Environment
        -----------

        PyRQA has been tested under Python 2.7 on Mac OS X (Mavericks, Yosemite) as well as openSUSE (12.2, 13.2).


        Contribution
        ------------

        PyRQA is the result of the work of computer scientists at the Humboldt University of Berlin and the GFZ German Research Centre for Geosciences.

        Acknowledgements
        ----------------

        We would like to thank Norbert Marwan from the Potsdam Institute for Climate Impact Research for his continuous support of the project.

        Publications
        ------------

        Please acknowledge the use of the PyRQA software by citing the following publication:

            Rawald, T., Sips, M., Marwan, N., Dransch, D. (2014): Fast Computation of Recurrences in Long Time Series. - In: Marwan, N., Riley, M., Guiliani, A., Webber, C. (Eds.), Translational Recurrences. From Mathematical Theory to Real-World Applications, (Springer Proceedings in Mathematics and Statistics ; 103), p. 17-29.

        For further information on the evaluation of different implementations, see:

            Rawald, T., Sips, M., Marwan, N., Leser, U. (2015): Massively Parallel Analysis of Similarity Matrices on Heterogeneous Hardware. - In: Fischer, P. M., Alonso, G., Arenas, M., Geerts, F. (Eds.), Proceedings of the Workshops of the EDBT/ICDT 2015 Joint Conference (EDBT/ICDT), (CEUR Workshop Proceedings ; 1330), p. 56-62.

Keywords: time series analysis,recurrence quantification analysis,RQA,recurrence plot
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2.7
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Scientific/Engineering :: Mathematics
Classifier: Topic :: Scientific/Engineering :: Physics