Skip to content

Commit 3718f6c

Browse files
committed
update default value of Settings.ProgressMeterKWARGS
1 parent c0270e7 commit 3718f6c

File tree

3 files changed

+5
-3
lines changed

3 files changed

+5
-3
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1212
- Use LinearSolve's internal methods for preconditioners in `SteadyStateLinearSolver`. ([#588])
1313
- Use `FillArrays.jl` for handling superoperators. This makes the code cleaner and potentially more efficient. ([#589])
1414
- Make sure state generating functions return dense array by default. ([#591])
15+
- Update default value of `Settings.ProgressMeterKWARGS`. ([#593])
1516

1617
## [v0.38.1]
1718
Release date: 2025-10-27
@@ -368,3 +369,4 @@ Release date: 2024-11-13
368369
[#588]: https://github.com/qutip/QuantumToolbox.jl/issues/588
369370
[#589]: https://github.com/qutip/QuantumToolbox.jl/issues/589
370371
[#591]: https://github.com/qutip/QuantumToolbox.jl/issues/591
372+
[#593]: https://github.com/qutip/QuantumToolbox.jl/issues/593

docs/src/users_guide/settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Here, we list out each setting along with the specific functions that will use i
1515
- `auto_tidyup::Bool = true` : Automatically tidyup during the following situations:
1616
* Solving for eigenstates, including [`eigenstates`](@ref), [`eigsolve`](@ref), [`eigsolve_al`](@ref)
1717
* Creating [`bloch_redfield_tensor`](@ref) or [`brterm`](@ref), and solving [`brmesolve`](@ref).
18-
- `ProgressMeterKWARGS::NamedTuple = (showspeed = true, printed = true)` : Default keyword arguments for progress bar in [`ProgressMeter.jl`](https://github.com/timholy/ProgressMeter.jl). This allows the customization of progress bar.
18+
- `ProgressMeterKWARGS::NamedTuple = (dt = 1.0, showspeed = true, printed = true)` : Default keyword arguments for progress bar in [`ProgressMeter.jl`](https://github.com/timholy/ProgressMeter.jl). This allows the customization of progress bar.
1919
- (to be announced)
2020

2121
## Change default settings

src/settings.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Base.@kwdef mutable struct Settings
22
tidyup_tol::Float64 = 1e-14
33
auto_tidyup::Bool = true
4-
ProgressMeterKWARGS::NamedTuple = (showspeed = true, printed = true)
4+
ProgressMeterKWARGS::NamedTuple = (dt = 1.0, showspeed = true, printed = true)
55
end
66

77
function Base.show(io::IO, s::Settings)
@@ -23,7 +23,7 @@ Contains all the default global settings of QuantumToolbox.jl.
2323
2424
- `tidyup_tol::Float64 = 1e-14` : tolerance for [`tidyup`](@ref) and [`tidyup!`](@ref).
2525
- `auto_tidyup::Bool = true` : Automatically tidyup.
26-
- `ProgressMeterKWARGS::NamedTuple = (showspeed = true, printed = true)` : Default keyword arguments for progress bar in [`ProgressMeter.jl`](https://github.com/timholy/ProgressMeter.jl). This allows the customization of progress bar.
26+
- `ProgressMeterKWARGS::NamedTuple = (dt = 1.0, showspeed = true, printed = true)` : Default keyword arguments for progress bar in [`ProgressMeter.jl`](https://github.com/timholy/ProgressMeter.jl). This allows the customization of progress bar.
2727
2828
For detailed explanation of each settings, see our documentation [here](https://qutip.org/QuantumToolbox.jl/stable/users_guide/settings).
2929

0 commit comments

Comments
 (0)