Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

streamlit GUI now optional install #17

Merged
merged 6 commits into from
Feb 15, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .github/workflows/ci_with_install.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,3 +48,8 @@ jobs:
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 .[gui]

6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 5 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,7 @@ classifiers = [
dependencies = [
"numpy>=1.21.1",
"matplotlib>=3.4.2",
"pandas",
"streamlit"
"pandas"
]
dynamic = ["version"]

Expand All @@ -34,7 +33,10 @@ openmc_cylindrical_mesh_plotter = "openmc_cylindrical_mesh_plotter.launch:main"

[project.optional-dependencies]
tests = [
"pytest",
"pytest"
]
gui = [
"streamlit"
]

[project.urls]
Expand Down
1 change: 0 additions & 1 deletion src/openmc_cylindrical_mesh_plotter/__init__.py
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
from .core import *
from .app import *
2 changes: 1 addition & 1 deletion src/openmc_cylindrical_mesh_plotter/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -206,7 +206,7 @@ def main():
volume_normalization=volume_normalization,
scaling_factor=scaling_factor,
colorbar_kwargs={"label": title},
norm=norm
norm=norm,
# outline_kwargs: dict = _default_outline_kwargs,
# **kwargs,
)
Expand Down
Loading