streamlit now optional

.github/workflows/ci_with_install.yml

@@ -34,17 +34,22 @@ jobs:
       - name: install packages for tests
         run: |
           pip install .[tests]
-
-      - name: Run test_utils
-        run: |
+          
+          - name: Run test_utils
+          run: |
           pytest tests
-
-      - name: Run examples
-        run: |
+          
+          - name: Run examples
+          run: |
           cd examples
           python plot_phir_slice_point_source_combined_multiple_tallies.py
           python plot_phir_slice_point_source.py
           python plot_phir_slice_ring_source.py
           python plot_rz_slice_point_source_combined_multiple_tallies.py
           python plot_rz_slices_point_source.py
           python plot_rz_slices_ring_source.py
+          
+      - name: install packages with GUI
+        run: |
+          pip install .
+          openmc_cylindrical_mesh_plotter

README.md

@@ -18,6 +18,12 @@ openmc_cylindrical_mesh_plotter is available on PyPi
 pip install openmc_cylindrical_mesh_plotter
 ```
 
+Install with the optional Graphical User Interface (GUI)
+
+```bash
+pip install openmc_cylindrical_mesh_plotter[gui]
+```
+
 ## API Usage
 
 See the [examples](https://github.com/fusion-energy/openmc_cylindrical_mesh_plotter/tree/main/examples) folder for example scripts

pyproject.toml

@@ -20,8 +20,7 @@ classifiers = [
 dependencies = [
     "numpy>=1.21.1",
     "matplotlib>=3.4.2",
-    "pandas",
-    "streamlit"
+    "pandas"
 ]
 dynamic = ["version"]
 
@@ -34,7 +33,10 @@ openmc_cylindrical_mesh_plotter = "openmc_cylindrical_mesh_plotter.launch:main"
 
 [project.optional-dependencies]
 tests = [
-    "pytest",
+    "pytest"
+]
+gui = [
+    "streamlit"
 ]
 
 [project.urls]

src/openmc_cylindrical_mesh_plotter/__init__.py

@@ -1,2 +1 @@
 from .core import *
-from .app import *