Merge pull request #162 from smash-transport/roch/PCA_flow

PCA flow
smash-transport · Dec 7, 2023 · c1aaa5d · c1aaa5d
2 parents 2969c05 + c52ef50
commit c1aaa5d
Show file tree

Hide file tree

Showing 6 changed files with 474 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -32,6 +32,7 @@ A `Deprecated` section could be added if needed for soon-to-be removed features.
 * GenerateFlow: Add functionality to generate flow with k-particle correlations
 * LeeYangZeroFlow: Add beta version of integrated and differential flow analysis with the Lee-Yang zero method
 * QCumulantFlow: Add beta version of integrated flow analysis with the Q-Cumulant method
+* PCAFlow: Add flow analysis with PCA method
 
 ### Fixed
 

diff --git a/docs/source/classes/flow/PCAFlow/index.rst b/docs/source/classes/flow/PCAFlow/index.rst
@@ -0,0 +1,10 @@
+.. _PCA_flow:
+
+PCAFlow
+=======
+
+.. currentmodule:: PCAFlow
+.. autoclass:: PCAFlow
+
+.. automethod:: PCAFlow.differential_flow
+.. automethod:: PCAFlow.Pearson_correlation
diff --git a/docs/source/classes/flow/index.rst b/docs/source/classes/flow/index.rst
@@ -11,5 +11,6 @@ Flow
    EventPlaneFlow/index
    LeeYangZeroFlow/index
    QCumulantFlow/index
+   PCAFlow/index
    GenerateFlow/index
 
diff --git a/src/sparkx/__init__.py b/src/sparkx/__init__.py
@@ -4,11 +4,12 @@
 from sparkx.flow.ScalarProductFlow import ScalarProductFlow
 from sparkx.flow.LeeYangZeroFlow import LeeYangZeroFlow
 from sparkx.flow.QCumulantFlow import QCumulantFlow
+from sparkx.flow.PCAFlow import PCAFlow
 from sparkx.flow.GenerateFlow import GenerateFlow
 from sparkx.Histogram import Histogram
 from sparkx.JetAnalysis import JetAnalysis
 from sparkx.Jetscape import Jetscape
 from sparkx.Lattice3D import Lattice3D
 from sparkx.Oscar import Oscar
 from sparkx.Particle import Particle
-from sparkx.Utilities import pdg_to_latex
+from sparkx.Utilities import pdg_to_latex