Skip to content

Commit f3adfd3

Browse files
committed
Fix study_parameters return types
1 parent e163157 commit f3adfd3

File tree

5 files changed

+11
-11
lines changed

5 files changed

+11
-11
lines changed

knowledge/how_to_use_fuse.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -820,7 +820,7 @@ Studies use a `sty` (study parameters) structure similar to `act` (actor paramet
820820

821821
```julia
822822
# Get study parameters - similar to case_parameters but for studies
823-
sty, act = FUSE.study_parameters(:TGLFdb)
823+
sty = FUSE.study_parameters(:TGLFdb)
824824

825825
# Common study parameters
826826
sty.server = "localhost" # Distributed computing server
@@ -841,7 +841,7 @@ sty.custom_tglf_models = ["sat3_em_d3d_azf-1_withnegD"] # Custom TGLF models to
841841
using Distributed
842842

843843
# 1. Setup study parameters
844-
sty, act = FUSE.study_parameters(:TGLFdb)
844+
sty = FUSE.study_parameters(:TGLFdb)
845845
sty.server = "localhost"
846846
sty.n_workers = 4
847847
sty.database_folder = "/path/to/database"
@@ -951,7 +951,7 @@ ylabel!("Probability")
951951

952952
```julia
953953
# Get study parameters for database generation
954-
sty, _ = FUSE.study_parameters(:DatabaseGenerator)
954+
sty = FUSE.study_parameters(:DatabaseGenerator)
955955

956956
# Configure distributed computing
957957
sty.server = "localhost"
@@ -1120,7 +1120,7 @@ ini.requirements.coil_stress_margin = 0.1 # 10% stress margin
11201120

11211121
```julia
11221122
# Get study parameters for multi-objective optimization
1123-
sty, _ = FUSE.study_parameters(:MultiObjectiveOptimizer)
1123+
sty = FUSE.study_parameters(:MultiObjectiveOptimizer)
11241124

11251125
# Configure distributed computing
11261126
sty.server = "localhost" # Can be "saga", "omega", or cluster name

src/studies/TGLF_database.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ import GACODE
77
#= ================= =#
88

99
"""
10-
study_parameters(::Val{:TGLFdb})::Tuple{FUSEparameters__ParametersStudyTGLFdb,ParametersAllActors}
10+
study_parameters(::Val{:TGLFdb})
1111
"""
12-
function study_parameters(::Val{:TGLFdb})::Tuple{FUSEparameters__ParametersStudyTGLFdb,ParametersAllActors}
12+
function study_parameters(::Val{:TGLFdb})
1313
return FUSEparameters__ParametersStudyTGLFdb{Real}()
1414
end
1515

src/studies/database_generator.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,15 @@ import HDF5
55
#= ====================== =#
66

77
"""
8-
study_parameters(::Val{:DatabaseGenerator})::Tuple{FUSEparameters__ParametersStudyDatabaseGenerator,ParametersAllActors}
8+
study_parameters(::Val{:DatabaseGenerator})
99
1010
Generates a database of dds from `ini` and `act` based on ranges specified in `ini` (i.e. `ini.equilibrium.R0 = 5.0 ↔ [4.0, 10.0]`)
1111
1212
It's also possible to run the database generator on Vector of `ini`s and `act`s. NOTE: the length of the `ini`s and `act`s must be the same.
1313
1414
There is a example notebook in `FUSE_examples/study_database_generator.ipynb` that goes through the steps of setting up, running and analyzing this study
1515
"""
16-
function study_parameters(::Val{:DatabaseGenerator})::Tuple{FUSEparameters__ParametersStudyDatabaseGenerator,ParametersAllActors}
16+
function study_parameters(::Val{:DatabaseGenerator})
1717
return FUSEparameters__ParametersStudyDatabaseGenerator{Real}()
1818
end
1919

src/studies/multi_objective_optimization.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@ import Serialization
44
#= ============================ =#
55

66
"""
7-
study_parameters(::Val{:MultiObjectiveOptimizer})::Tuple{FUSEparameters__ParametersStudyMultiObjectiveOptimizer,ParametersAllActors}
7+
study_parameters(::Val{:MultiObjectiveOptimizer})
88
99
Generates a database of dds from ini and act based on ranges specified in ini
1010
"""
11-
function study_parameters(::Val{:MultiObjectiveOptimizer})::Tuple{FUSEparameters__ParametersStudyMultiObjectiveOptimizer,ParametersAllActors}
11+
function study_parameters(::Val{:MultiObjectiveOptimizer})
1212
return FUSEparameters__ParametersStudyMultiObjectiveOptimizer{Real}()
1313
end
1414

test/runtests_study.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ using FUSE.DataFrames
77
using FUSE.SimulationParameters.Distributions
88

99
@testset "study_db_gen" begin
10-
sty, act = FUSE.study_parameters(:DatabaseGenerator)
10+
sty = FUSE.study_parameters(:DatabaseGenerator)
1111
sty.server = "localhost"
1212
sty.n_workers = 2
1313
sty.file_save_mode = :append

0 commit comments

Comments
 (0)