Skip to content

Commit

Permalink
Make progress bar optional (#109)
Browse files Browse the repository at this point in the history 
* Make progress bar optional

* Run notebooks
  • Loading branch information
@loganbvh
loganbvh committed Nov 3, 2023
1 parent 799f545 commit 82eb20c
Show file tree
Hide file tree
Showing 8 changed files with 40 additions and 35 deletions.
10 changes: 5 additions & 5 deletions docs/notebooks/field-sources.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -87,8 +87,8 @@
{
"data": {
"text/html": [
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.3</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Wed Oct 04 10:31:44 2023 PDT</td></tr></table>"
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.5</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Fri Nov 03 08:50:12 2023 PDT</td></tr></table>"
],
"text/plain": [
"<IPython.core.display.HTML object>"
Expand Down Expand Up @@ -142,9 +142,9 @@
"name": "stdout",
"output_type": "stream",
"text": [
"x = 0.3396785462775239\n",
"y = 0.5560346157741703\n",
"z = 0.47978056547366055\n",
"x = 0.4017257109450827\n",
"y = 0.050869003224076836\n",
"z = 0.6940796507836845\n",
"field(x, y, z) = 5.0\n"
]
}
Expand Down
4 changes: 2 additions & 2 deletions docs/notebooks/logo.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,8 +59,8 @@
{
"data": {
"text/html": [
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.3</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Wed Oct 04 10:32:27 2023 PDT</td></tr></table>"
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.5</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Fri Nov 03 08:49:37 2023 PDT</td></tr></table>"
],
"text/plain": [
"<IPython.core.display.HTML object>"
Expand Down
20 changes: 10 additions & 10 deletions docs/notebooks/polygons.ipynb
View file

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions docs/notebooks/quickstart.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,8 @@
{
"data": {
"text/html": [
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.3</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Wed Oct 04 10:28:14 2023 PDT</td></tr></table>"
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.5</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Fri Nov 03 08:49:17 2023 PDT</td></tr></table>"
],
"text/plain": [
"<IPython.core.display.HTML object>"
Expand Down Expand Up @@ -1105,7 +1105,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"Holes: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████| 2/2 [00:00<00:00, 2.55it/s]"
"Holes: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████| 2/2 [00:01<00:00, 1.88it/s]"
]
},
{
Expand Down Expand Up @@ -1193,7 +1193,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"Holes: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████| 2/2 [00:00<00:00, 2.77it/s]\n"
"Holes: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████| 2/2 [00:00<00:00, 2.41it/s]\n"
]
}
],
Expand Down Expand Up @@ -1430,7 +1430,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"Solver iterations: 100%|█████████████████████████████████████████████████████████████████████████████████████████████| 10/10 [00:02<00:00, 4.06it/s]\n"
"Solver iterations: 100%|█████████████████████████████████████████████████████████████████████████████████████████████| 10/10 [00:02<00:00, 4.30it/s]\n"
]
}
],
Expand Down
12 changes: 6 additions & 6 deletions docs/notebooks/scanning-squid.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -97,8 +97,8 @@
{
"data": {
"text/html": [
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.3</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Wed Oct 04 10:29:53 2023 PDT</td></tr></table>"
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.5</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Fri Nov 03 08:50:53 2023 PDT</td></tr></table>"
],
"text/plain": [
"<IPython.core.display.HTML object>"
Expand Down Expand Up @@ -160,10 +160,10 @@
"name": "stderr",
"output_type": "stream",
"text": [
"Solver iterations: 100%|███████████████████████████████████████████████████████████████████████████████████████████████| 5/5 [00:01<00:00, 2.65it/s]\n",
"Solver iterations: 100%|███████████████████████████████████████████████████████████████████████████████████████████████| 5/5 [00:01<00:00, 2.81it/s]\n",
"Solver iterations: 100%|███████████████████████████████████████████████████████████████████████████████████████████████| 5/5 [00:03<00:00, 1.41it/s]\n",
"Solver iterations: 100%|███████████████████████████████████████████████████████████████████████████████████████████████| 5/5 [00:03<00:00, 1.61it/s]\n"
"Solver iterations: 100%|███████████████████████████████████████████████████████████████████████████████████████████████| 5/5 [00:01<00:00, 2.71it/s]\n",
"Solver iterations: 100%|███████████████████████████████████████████████████████████████████████████████████████████████| 5/5 [00:01<00:00, 3.15it/s]\n",
"Solver iterations: 100%|███████████████████████████████████████████████████████████████████████████████████████████████| 5/5 [00:03<00:00, 1.29it/s]\n",
"Solver iterations: 100%|███████████████████████████████████████████████████████████████████████████████████████████████| 5/5 [00:03<00:00, 1.46it/s]\n"
]
}
],
Expand Down
6 changes: 3 additions & 3 deletions docs/notebooks/terminal-currents.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@
{
"data": {
"text/html": [
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.3</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Wed Oct 04 10:29:14 2023 PDT</td></tr></table>"
"<table><tr><th>Software</th><th>Version</th></tr><tr><td>SuperScreen</td><td>0.10.5</td></tr><tr><td>Numpy</td><td>1.23.3</td></tr><tr><td>Numba</td><td>0.57.0</td></tr><tr><td>SciPy</td><td>1.9.1</td></tr><tr><td>matplotlib</td><td>3.6.0</td></tr><tr><td>IPython</td><td>8.5.0</td></tr><tr><td>Python</td><td>3.9.13 | packaged by conda-forge | (main, May 27 2022, 17:01:00) \n",
"[Clang 13.0.1 ]</td></tr><tr><td>OS</td><td>posix [darwin]</td></tr><tr><td>Number of CPUs</td><td>Physical: 10, Logical: 10</td></tr><tr><td>BLAS Info</td><td>OPENBLAS</td></tr><tr><td colspan='2'>Fri Nov 03 08:50:39 2023 PDT</td></tr></table>"
],
"text/plain": [
"<IPython.core.display.HTML object>"
Expand Down Expand Up @@ -480,7 +480,7 @@
"name": "stderr",
"output_type": "stream",
"text": [
"Holes: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████| 2/2 [00:00<00:00, 3.01it/s]\n"
"Holes: 100%|███████████████████████████████████████████████████████████████████████████████████████████████████████████| 2/2 [00:00<00:00, 2.77it/s]\n"
]
}
],
Expand Down
11 changes: 8 additions & 3 deletions superscreen/solver/solve.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -285,6 +285,7 @@ def solve(
return_solutions: bool = True,
save_path: Optional[os.PathLike] = None,
log_level: Optional[int] = None,
progress_bar: bool = True,
_solver: str = "superscreen.solve",
) -> List[Solution]:
"""Computes the stream functions and magnetic fields for all layers in a ``Device``.
Expand Down Expand Up @@ -323,6 +324,7 @@ def solve(
return_solutions: Whether to return a list of Solution objects.
save_path: Path to an HDF5 file in which to save the results.
log_level: Logging level to use, if any.
progress_bar: Show a progress bar for self-consistent iterations.
_solver: Name of the solver method used.
Returns:
Expand Down Expand Up @@ -355,10 +357,11 @@ def solve(
"If model argument is provided, device, terminal_currents,"
" circulating_currents, and vortices must be None."
)
if current_units is not None:
if current_units is not None and current_units != model.current_units:
logger.warning(
"Keyword argument 'current_units' is ignored when "
"a factorized model is provided."
"a factorized model is provided. "
f"Using model.current_units = {model.current_units!r}"
)

if not isinstance(model, FactorizedModel):
Expand Down Expand Up @@ -460,7 +463,9 @@ def solve(
return solutions
return

for i in tqdm(range(iterations), desc="Solver iterations"):
for i in tqdm(
range(iterations), desc="Solver iterations", disable=(not progress_bar)
):
# Calculate the screening fields at each layer from every other layer
other_screening_fields = {
name: np.zeros(len(mesh.sites), dtype=dtype)
Expand Down
2 changes: 1 addition & 1 deletion superscreen/version.py
View file
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__version_info__ = (0, 10, 4)
__version_info__ = (0, 10, 5)
__version__ = ".".join(map(str, __version_info__))

0 comments on commit 82eb20c

Please sign in to comment.