Split plotting functionality from SkyScanResult (#28)

* remove SkyScanResult attributes and methods * <bot> update requirements-examples.txt * <bot> update requirements-tests.txt * <bot> update requirements.txt * remove plotting stuff * mypy partial compliance * mypy compliance * test compliance * documentation * add __all__ for flake8 compliance * move logger * logging no longer needed * bump ci * add `mypy` extra for ci * add optional output dir * <bot> update setup.cfg * <bot> update .gitignore * <bot> update dependencies*.log files(s) --------- Co-authored-by: wipacdevbot <[email protected]> Co-authored-by: Ric Evans <[email protected]>
icecube · Oct 22, 2023 · dcb25a0 · dcb25a0
1 parent 0de5408
commit dcb25a0
Show file tree

Hide file tree

Showing 12 changed files with 326 additions and 1,378 deletions.
diff --git a/.github/workflows/wipac-cicd.yml b/.github/workflows/wipac-cicd.yml
@@ -13,6 +13,15 @@ env:
 
 jobs:
 
+  py-versions:
+    runs-on: ubuntu-latest
+    outputs:
+      matrix: ${{ steps.versions.outputs.matrix }}
+    steps:
+      - uses: actions/checkout@v3
+      - id: versions
+        uses: WIPACrepo/[email protected]
+
   flake8:
     runs-on: ubuntu-latest
     steps:
@@ -21,11 +30,18 @@ jobs:
       - uses: WIPACrepo/[email protected]
 
   mypy:
+    needs: [py-versions]
     runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        py3: ${{ fromJSON(needs.py-versions.outputs.matrix) }}
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-python@v3
-      - uses: WIPACrepo/[email protected]
+        with:
+          python-version: ${{ matrix.py3 }}
+      - uses: WIPACrepo/[email protected]
 
   py-setup:
     runs-on: ubuntu-latest
@@ -43,21 +59,12 @@ jobs:
           github.actor != 'dependabot[bot]' &&
           github.ref_type == 'branch'
         name: wipac-dev-py-setup-action (only for non-dependabot non-default branches)
-        uses: WIPACrepo/wipac-dev-py-setup-action@v1.14
+        uses: WIPACrepo/wipac-dev-py-setup-action@v2.7
         with:
           base-keywords: IceCube
           git_committer_name: ${{ env.BOT_NAME }}
           git_committer_email: ${{ env.BOT_EMAIL }}
 
-  py-versions:
-    runs-on: ubuntu-latest
-    outputs:
-      matrix: ${{ steps.versions.outputs.matrix }}
-    steps:
-      - uses: actions/checkout@v3
-      - id: versions
-        uses: WIPACrepo/[email protected]
-
   unit-tests:
     needs: [py-versions]
     runs-on: ubuntu-latest

diff --git a/.gitignore b/.gitignore
@@ -131,4 +131,7 @@ dmypy.json
 
 
 *-token
-*.token
+*.token
+
+# wipac-dev-py-setup-action
+!dependencies*.log
diff --git a/requirements-examples.txt → dependencies-examples.log b/requirements-examples.txt → dependencies-examples.log
@@ -1,8 +1,8 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    pip-compile --extra=examples --output-file=requirements-examples.txt
+#    pip-compile --extra=examples --output-file=dependencies-examples.log
 #
 astropy==5.3.4
     # via
@@ -36,7 +36,7 @@ matplotlib==3.8.0
     #   icecube-skyreader (setup.py)
 meander==0.0.3
     # via icecube-skyreader (setup.py)
-numpy==1.26.0
+numpy==1.26.1
     # via
     #   astropy
     #   contourpy
@@ -52,14 +52,16 @@ packaging==23.2
     #   matplotlib
 pandas==2.1.1
     # via icecube-skyreader (setup.py)
-pillow==10.0.1
+pillow==10.1.0
     # via matplotlib
 pycparser==2.21
     # via cffi
-pyerfa==2.0.0.3
+pyerfa==2.0.1.1
     # via astropy
 pyjwt[crypto]==2.8.0
-    # via wipac-rest-tools
+    # via
+    #   pyjwt
+    #   wipac-rest-tools
 pyparsing==3.1.1
     # via matplotlib
 pypng==0.20220715.0
@@ -93,7 +95,7 @@ typing-extensions==4.8.0
     #   wipac-dev-tools
 tzdata==2023.3
     # via pandas
-urllib3==2.0.6
+urllib3==2.0.7
     # via
     #   requests
     #   wipac-rest-tools

diff --git a/dependencies-mypy.log b/dependencies-mypy.log
@@ -0,0 +1,118 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile --extra=mypy --output-file=dependencies-mypy.log
+#
+astropy==5.3.4
+    # via
+    #   healpy
+    #   icecube-skyreader (setup.py)
+cachetools==5.3.1
+    # via wipac-rest-tools
+certifi==2023.7.22
+    # via requests
+cffi==1.16.0
+    # via cryptography
+charset-normalizer==3.3.0
+    # via requests
+contourpy==1.1.1
+    # via matplotlib
+cryptography==41.0.4
+    # via pyjwt
+cycler==0.12.1
+    # via matplotlib
+fonttools==4.43.1
+    # via matplotlib
+healpy==1.16.6
+    # via icecube-skyreader (setup.py)
+idna==3.4
+    # via requests
+iniconfig==2.0.0
+    # via pytest
+kiwisolver==1.4.5
+    # via matplotlib
+matplotlib==3.8.0
+    # via
+    #   healpy
+    #   icecube-skyreader (setup.py)
+meander==0.0.3
+    # via icecube-skyreader (setup.py)
+numpy==1.26.1
+    # via
+    #   astropy
+    #   contourpy
+    #   healpy
+    #   icecube-skyreader (setup.py)
+    #   matplotlib
+    #   pandas
+    #   pyerfa
+    #   scipy
+packaging==23.2
+    # via
+    #   astropy
+    #   matplotlib
+    #   pytest
+pandas==2.1.1
+    # via icecube-skyreader (setup.py)
+pillow==10.1.0
+    # via matplotlib
+pluggy==1.3.0
+    # via pytest
+pycparser==2.21
+    # via cffi
+pyerfa==2.0.1.1
+    # via astropy
+pyjwt[crypto]==2.8.0
+    # via
+    #   pyjwt
+    #   wipac-rest-tools
+pyparsing==3.1.1
+    # via matplotlib
+pypng==0.20220715.0
+    # via qrcode
+pytest==7.4.2
+    # via
+    #   icecube-skyreader (setup.py)
+    #   pytest-mock
+pytest-mock==3.12.0
+    # via icecube-skyreader (setup.py)
+python-dateutil==2.8.2
+    # via
+    #   matplotlib
+    #   pandas
+pytz==2023.3.post1
+    # via pandas
+pyyaml==6.0.1
+    # via astropy
+qrcode==7.4.2
+    # via wipac-rest-tools
+requests==2.31.0
+    # via
+    #   requests-futures
+    #   wipac-dev-tools
+    #   wipac-rest-tools
+requests-futures==1.0.1
+    # via wipac-rest-tools
+scipy==1.11.3
+    # via healpy
+six==1.16.0
+    # via python-dateutil
+tornado==6.3.3
+    # via wipac-rest-tools
+typing-extensions==4.8.0
+    # via
+    #   qrcode
+    #   wipac-dev-tools
+tzdata==2023.3
+    # via pandas
+urllib3==2.0.7
+    # via
+    #   requests
+    #   wipac-rest-tools
+wipac-dev-tools==1.7.0
+    # via
+    #   icecube-skyreader (setup.py)
+    #   wipac-rest-tools
+wipac-rest-tools==1.6.0
+    # via icecube-skyreader (setup.py)
diff --git a/requirements-tests.txt → dependencies-tests.log b/requirements-tests.txt → dependencies-tests.log
@@ -1,8 +1,8 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    pip-compile --extra=tests --output-file=requirements-tests.txt
+#    pip-compile --extra=tests --output-file=dependencies-tests.log
 #
 astropy==5.3.4
     # via
@@ -16,8 +16,6 @@ contourpy==1.1.1
     # via matplotlib
 cycler==0.12.1
     # via matplotlib
-exceptiongroup==1.1.3
-    # via pytest
 fonttools==4.43.1
     # via matplotlib
 healpy==1.16.6
@@ -34,7 +32,7 @@ matplotlib==3.8.0
     #   icecube-skyreader (setup.py)
 meander==0.0.3
     # via icecube-skyreader (setup.py)
-numpy==1.26.0
+numpy==1.26.1
     # via
     #   astropy
     #   contourpy
@@ -51,19 +49,19 @@ packaging==23.2
     #   pytest
 pandas==2.1.1
     # via icecube-skyreader (setup.py)
-pillow==10.0.1
+pillow==10.1.0
     # via matplotlib
 pluggy==1.3.0
     # via pytest
-pyerfa==2.0.0.3
+pyerfa==2.0.1.1
     # via astropy
 pyparsing==3.1.1
     # via matplotlib
 pytest==7.4.2
     # via
     #   icecube-skyreader (setup.py)
     #   pytest-mock
-pytest-mock==3.11.1
+pytest-mock==3.12.0
     # via icecube-skyreader (setup.py)
 python-dateutil==2.8.2
     # via
@@ -79,13 +77,11 @@ scipy==1.11.3
     # via healpy
 six==1.16.0
     # via python-dateutil
-tomli==2.0.1
-    # via pytest
 typing-extensions==4.8.0
     # via wipac-dev-tools
 tzdata==2023.3
     # via pandas
-urllib3==2.0.6
+urllib3==2.0.7
     # via requests
 wipac-dev-tools==1.7.0
     # via icecube-skyreader (setup.py)
diff --git a/requirements.txt → dependencies.log b/requirements.txt → dependencies.log
@@ -1,8 +1,8 @@
 #
-# This file is autogenerated by pip-compile with Python 3.10
+# This file is autogenerated by pip-compile with Python 3.11
 # by the following command:
 #
-#    pip-compile --output-file=requirements.txt
+#    pip-compile --output-file=dependencies.log
 #
 astropy==5.3.4
     # via
@@ -30,7 +30,7 @@ matplotlib==3.8.0
     #   icecube-skyreader (setup.py)
 meander==0.0.3
     # via icecube-skyreader (setup.py)
-numpy==1.26.0
+numpy==1.26.1
     # via
     #   astropy
     #   contourpy
@@ -46,9 +46,9 @@ packaging==23.2
     #   matplotlib
 pandas==2.1.1
     # via icecube-skyreader (setup.py)
-pillow==10.0.1
+pillow==10.1.0
     # via matplotlib
-pyerfa==2.0.0.3
+pyerfa==2.0.1.1
     # via astropy
 pyparsing==3.1.1
     # via matplotlib
@@ -70,7 +70,7 @@ typing-extensions==4.8.0
     # via wipac-dev-tools
 tzdata==2023.3
     # via pandas
-urllib3==2.0.6
+urllib3==2.0.7
     # via requests
 wipac-dev-tools==1.7.0
     # via icecube-skyreader (setup.py)
diff --git a/examples/plot_skydriver_scan_result.py b/examples/plot_skydriver_scan_result.py
@@ -5,6 +5,7 @@
 
 from rest_tools.client import RestClient, SavedDeviceGrantAuth
 from skyreader import SkyScanResult
+from skyreader.plot import SkyScanPlotter
 
 
 def get_rest_client() -> RestClient:
@@ -36,11 +37,14 @@ def main() -> None:
     args = parser.parse_args()
 
     rc = get_rest_client()
-    serialzed = rc.request_seq("GET", f"/scan/{args.scan_id}/result")["skyscan_result"]
+    serialized = rc.request_seq("GET", f"/scan/{args.scan_id}/result")["skyscan_result"]
 
-    result = SkyScanResult.deserialize(serialzed)
-    result.create_plot()
-    result.create_plot_zoomed(plot_bounding_box=True)
+    plotter = SkyScanPlotter()
+
+    result = SkyScanResult.deserialize(serialized)
+
+    plotter.create_plot(result)
+    plotter.create_plot_zoomed(result, plot_bounding_box=True)
 
 
 if __name__ == "__main__":

diff --git a/setup.cfg b/setup.cfg
@@ -63,6 +63,9 @@ tests =
 	pytest-mock
 examples =
 	wipac-rest-tools
+mypy =
+	%(tests)s
+	%(examples)s
 
 [options.package_data]  # generated by wipac:cicd_setup_builder: '*'
 * = py.typed

diff --git a/skyreader/plot/__init__.py b/skyreader/plot/__init__.py
@@ -0,0 +1,3 @@
+from .plot import SkyScanPlotter
+
+__all__ = ["SkyScanPlotter"]