Error: Key GENERIC_INSTRUMENT must be defined when using Generic Instrument ; generic.generic_validate called before reading parameters from wrapfile

[LouiseDyregaard]

When using a generic instrument (MaHPS @ Wendelstein) we get the error:
"Key GENERIC_INSTRUMENT must be defined when using Generic Instrument"

It seems that the generic.generic_validate method is called before reading parameters from our wrapfile; ie. None from parameters.py is used when validating the GENERIC_ parameters, resulting in an error.

Our current workaround is to set GENERIC_INSTRUMENT (and other GENERIC_ parameters) to anything but None in parameters.py. These parameters are later overwritten in select.py (select.load_instrument) with our user-defined inputs from our wrap file.

Adding our wrap file (lbl_test1.py.txt) for you to recreate the error (as .txt because github doesn't allow .py attachments(?!).

[njcuk9999]

Okay interesting, I changed some stuff around and seems I broke the logic for the Generic Instrument.

For most instruments we do the following:

1. load defaults
2. load defaults for that instrument / data source
3. load command line / yaml / wrap args

For generic it needs to be different:

1. load defaults
2. load command line / yaml /wrap args
3. load "defaults" for instrument (which actually just checks you have everything from step 2 - as the generic instrument doesn't have any defaults - by design

As you say the way I had changed it, it worked for the "most instruments" mode but not for the generic... so I've moved the order steps 2 and 3 are done inside the individual Instrument classes.

All that is more for me (or any one who sees this later). For you can you test the developer branch with your wrap file.

Note you will 100% get crashes until ALL parameters are set in the "Other settings" section... you have no choice here you MUST set all of them - LBL doesn't know what to do with your data until you set these (by "set" I mean they cannot be None.

I see at least these few that need setting:

rparams['GENERIC_DATA_SOURCE'] = None
rparams['EARTH_LOCATION'] = None
rparams['COMPIL_ADD_UNIFORM_WAVEBIN'] = None
rparams['COMPIL_NUM_UNIFORM_WAVEBIN'] = None
rparams['TELLUCLEAN_MAX_ITERATIONS'] = None
rparams['TELLUCLEAN_TRANSMISSION_THRESHOLD'] = None
rparams['TELLUCLEAN_SIGMA_THRESHOLD'] = None

The comments should be sufficient to set these values, but let me know if they aren't (or check one of the defined instruments)

[ChewyyHam]

When initiating the Generic class we get the error:
(lbl_env) E:\Masters\Data\lbl_test3>lbl_setup lbl_test3.py
2025-06-12 15:34:40.327|I| This script creates a wrap file for LBL processing

Please enter the instrument (from: SPIROU, HARPS, ESPRESSO, CARMENES, NIRPS_HA, NIRPS_HE, HARPSN, MAROONX, SOPHIE, CORALIE, Generic): Generic

Please enter the data_dir: E:\Masters\Data\lbl_test3
Traceback (most recent call last):
File "", line 198, in _run_module_as_main
File "", line 88, in run_code
File "E:\Anaconda\envs\lbl_env\Scripts\lbl_setup.exe_main.py", line 7, in
File "E:\lbl-developer\lbl-developer\lbl\recipes\lbl_setup.py", line 310, in run
_ = main()
^^^^^^
File "E:\lbl-developer\lbl-developer\lbl\recipes\lbl_setup.py", line 185, in main
inst = instrument(parameters.params.copy(), setup=True)
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
TypeError: Generic.init() missing 1 required positional argument: 'args'

We think this is due to the fact now that all instrument classes require one additional argument: args. But when the instrument is initiated only the old two arguments were provided as shown in the link below:

lbl/lbl/recipes/lbl_setup.py

Line 185 in af2b496

inst = instrument(parameters.params.copy(), setup=True)

[njcuk9999]

Sorry yes, I didn't re-test the setup script, this should be fixed in the main branch now.