Rename the package from p3 to p3analysis

"p3" is already the name of an existing Python package. "p3analysis" was chosen as our replacement name because it is descriptive, and allows for future p3-related packages to follow a similar naming convention. Signed-off-by: John Pennycook <[email protected]>
intel · Sep 4, 2024 · 9d2bcdf · 9d2bcdf
1 parent def324f
commit 9d2bcdf
Show file tree

Hide file tree

Showing 56 changed files with 292 additions and 279 deletions.
diff --git a/.github/workflows/build-unittest.yml b/.github/workflows/build-unittest.yml
@@ -8,14 +8,14 @@ on:
   push:
     branches: [ "main" ]
     paths:
-    - 'p3/**'
+    - 'p3analysis/**'
     - 'tests/**'
     - 'pyproject.toml'
     - 'MANIFEST.in'
   pull_request:
     branches: [ "main" ]
     paths:
-    - 'p3/**'
+    - 'p3analysis/**'
     - 'tests/**'
     - 'pyproject.toml'
     - 'MANIFEST.in'
@@ -31,7 +31,7 @@ jobs:
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install p3 and its dependencies
+    - name: Install p3analysis and its dependencies
       run: pip install --no-cache-dir './[dev]'
     - name: Run unittest
       run: python -m unittest discover -s tests --verbose

diff --git a/.github/workflows/test-gallery.yml b/.github/workflows/test-gallery.yml
@@ -9,15 +9,15 @@ on:
   push:
     branches: [ "main" ]
     paths:
-    - 'p3/**'
+    - 'p3analysis/**'
     - 'examples/**'
     - 'case-studies/**'
     - 'pyproject.toml'
     - 'MANIFEST.in'
   pull_request:
     branches: [ "main" ]
     paths:
-    - 'p3/**'
+    - 'p3analysis/**'
     - 'examples/**'
     - 'case-studies/**'
     - 'pyproject.toml'
@@ -35,7 +35,7 @@ jobs:
       uses: actions/setup-python@v3
       with:
         python-version: ${{ matrix.python-version }}
-    - name: Install p3 and its dependencies
+    - name: Install p3analysis and its dependencies
       run: pip install --no-cache-dir './[dev]'
     - name: Run examples
       run: |

diff --git a/case-studies/babelstream/plot_babelstream_cascade.py b/case-studies/babelstream/plot_babelstream_cascade.py
@@ -20,12 +20,14 @@
 # Load Data into Pandas
 # ---------------------
 
+#sphinx_gallery_start_ignore
+import os
+
 # import libraries
 import pandas as pd
-import p3
 
-#sphinx_gallery_start_ignore
-import os
+import p3analysis
+
 dpath = os.path.realpath(os.getcwd())
 performance_csv = os.path.join(dpath, "performance.csv")
 #sphinx_gallery_end_ignore
@@ -36,11 +38,11 @@
 # %%
 # Project Labels into Expected Forms
 # ----------------------------------
-# The :py:func:`p3.data.projection` method can be used to project column names
+# The :py:func:`p3analysis.data.projection` method can be used to project column names
 # from the original data into names required by the P3 Analysis Library.
 
-df = p3.data.projection(
-    df, problem=["name"], platform=["arch"], application=["language"]
+df = p3analysis.data.projection(
+    df, problem=["name"], platform=["arch"], application=["language"],
 )
 
 # %%
@@ -67,14 +69,14 @@
 # (problem, platform) combination; any row with an `app eff` of 1 represents
 # an application achieving the best-known performance.
 
-effs = p3.metrics.application_efficiency(df)
+effs = p3analysis.metrics.application_efficiency(df)
 print(effs)
 
 # %%
 # Generate a Cascade Plot
 # -----------------------
 
-cascade = p3.plot.cascade(effs)
+cascade = p3analysis.plot.cascade(effs)
 cascade.save("cascade.png")
 
 # %%

diff --git a/case-studies/babelstream/plot_babelstream_navchart.py b/case-studies/babelstream/plot_babelstream_navchart.py
@@ -16,12 +16,14 @@
 # Load Data into Pandas
 # ---------------------
 
+#sphinx_gallery_start_ignore
+import os
+
 # import libraries
 import pandas as pd
-import p3
 
-#sphinx_gallery_start_ignore
-import os
+import p3analysis
+
 dpath = os.path.realpath(os.getcwd())
 performance_csv = os.path.join(dpath, "performance.csv")
 coverage_csv = os.path.join(dpath, "coverage.csv")
@@ -40,11 +42,11 @@
 # %%
 # Project Labels into Expected Forms
 # ----------------------------------
-# The :py:func:`p3.data.projection` method can be used to project column names
+# The :py:func:`p3analysis.data.projection` method can be used to project column names
 # from the original data into names required by the P3 Analysis Library.
 
-df = p3.data.projection(
-    df, problem=["name"], platform=["arch"], application=["language"]
+df = p3analysis.data.projection(
+    df, problem=["name"], platform=["arch"], application=["language"],
 )
 
 # %%
@@ -74,7 +76,7 @@
 # (problem, platform) combination; any row with an `app eff` of 1 represents
 # an application achieving the best-known performance.
 
-effs = p3.metrics.application_efficiency(df)
+effs = p3analysis.metrics.application_efficiency(df)
 print(effs)
 
 # %%
@@ -85,7 +87,7 @@
 # has a non-zero divergence, as it is the only implementation containing
 # different code paths for different platforms.
 
-div = p3.metrics.divergence(df, df_cov)
+div = p3analysis.metrics.divergence(df, df_cov)
 print(div)
 
 # %%
@@ -96,14 +98,14 @@
 # to achieve a non-zero performance portability score. For BabelStream,
 # Language 0 is the only programming model that runs across all 11 platforms.
 
-pp = p3.metrics.pp(effs)
+pp = p3analysis.metrics.pp(effs)
 print(pp)
 
 # %%
 # Generate a Navigation Chart
 # ---------------------------
 
-navchart = p3.plot.navchart(pp, div)
+navchart = p3analysis.plot.navchart(pp, div)
 navchart.save("navchart.png")
 
 # %%

diff --git a/docs/source/analysis.rst b/docs/source/analysis.rst
@@ -41,5 +41,5 @@ The terminology used by the P3 Analysis Library was first introduced in
 Some of these definitions are flexible, allowing the same performance data
 to be used for multiple case studies with different interpretations of these
 terms. The library is designed with this flexibility in mind (see
-:py:func:`p3.data.projection`); concrete definitions are not required when
+:py:func:`p3analysis.data.projection`); concrete definitions are not required when
 collecting data.
diff --git a/docs/source/data.rst b/docs/source/data.rst
@@ -37,7 +37,7 @@ The following fields have special meaning:
 
 It is recommended not to store *application*, *problem* and *platform* fields
 when results are initially collected, and to instead construct them using the
-:py:func:`p3.data.projection` function. This makes it simpler to re-use the
+:py:func:`p3analysis.data.projection` function. This makes it simpler to re-use the
 same data across multiple analyses using different meanings of *application*,
 *problem*, and *platform*.
 

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -23,7 +23,7 @@ Performance, Portability, and Productivity Analysis Library
    :hidden:
    :caption: Reference
 
-   p3
+   p3analysis
 
 .. toctree::
    :maxdepth: 1
@@ -38,11 +38,11 @@ The Performance, Portability, and Productivity Analysis Library (P3 Analysis
 Library) enables a simpler workflow for the collection and interpretation of P3
 data.
 
-- Compute :doc:`metrics <p3.metrics>` like "performance portability" and
+- Compute :doc:`metrics <p3analysis.metrics>` like "performance portability" and
   "code divergence" to quantify the trade-offs between performance, portability
   and productivity made by applications targeting multiple platforms.
 
-- :doc:`Plot <p3.plot>` cascades and navigation charts to visualize and gain
+- :doc:`Plot <p3analysis.plot>` cascades and navigation charts to visualize and gain
   deeper insight into the "performance portability" and "code divergence"
   scores achieved by different applications.
 

diff --git a/docs/source/modules.rst b/docs/source/modules.rst
@@ -1,7 +1,7 @@
-p3
-==
+p3analysis
+==========
 
 .. toctree::
    :maxdepth: 4
 
-   p3
+   p3analysis
diff --git a/docs/source/p3.plot.backend.rst b/docs/source/p3.plot.backend.rst
diff --git a/docs/source/p3.plot.rst b/docs/source/p3.plot.rst
diff --git a/docs/source/p3.report.rst b/docs/source/p3.report.rst
diff --git a/docs/source/p3.data.rst → docs/source/p3analysis.data.rst b/docs/source/p3.data.rst → docs/source/p3analysis.data.rst
@@ -1,10 +1,10 @@
-p3.data package
-===============
+p3analysis.data package
+=======================
 
 Module contents
 ---------------
 
-.. automodule:: p3.data
+.. automodule:: p3analysis.data
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/p3analysis.metrics.rst b/docs/source/p3analysis.metrics.rst
@@ -0,0 +1,10 @@
+p3analysis.metrics package
+==========================
+
+Module contents
+---------------
+
+.. automodule:: p3analysis.metrics
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/p3analysis.plot.backend.rst b/docs/source/p3analysis.plot.backend.rst
@@ -0,0 +1,29 @@
+p3analysis.plot.backend package
+===============================
+
+Submodules
+----------
+
+p3analysis.plot.backend.matplotlib module
+-----------------------------------------
+
+.. automodule:: p3analysis.plot.backend.matplotlib
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+p3analysis.plot.backend.pgfplots module
+---------------------------------------
+
+.. automodule:: p3analysis.plot.backend.pgfplots
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: p3analysis.plot.backend
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/source/p3.rst → docs/source/p3analysis.plot.rst b/docs/source/p3.rst → docs/source/p3analysis.plot.rst
@@ -1,21 +1,18 @@
-p3 package
-==========
+p3analysis.plot package
+=======================
 
 Subpackages
 -----------
 
 .. toctree::
    :maxdepth: 4
 
-   p3.data
-   p3.metrics
-   p3.plot
-   p3.report
+   p3analysis.plot.backend
 
 Module contents
 ---------------
 
-.. automodule:: p3
+.. automodule:: p3analysis.plot
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/p3.metrics.rst → docs/source/p3analysis.report.rst b/docs/source/p3.metrics.rst → docs/source/p3analysis.report.rst
@@ -1,10 +1,10 @@
-p3.metrics package
-==================
+p3analysis.report package
+=========================
 
 Module contents
 ---------------
 
-.. automodule:: p3.metrics
+.. automodule:: p3analysis.report
    :members:
    :undoc-members:
    :show-inheritance:
diff --git a/docs/source/p3analysis.rst b/docs/source/p3analysis.rst
@@ -0,0 +1,21 @@
+p3analysis package
+==================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   p3analysis.data
+   p3analysis.metrics
+   p3analysis.plot
+   p3analysis.report
+
+Module contents
+---------------
+
+.. automodule:: p3analysis
+   :members:
+   :undoc-members:
+   :show-inheritance: