5.1. recipe_system package

recipe_system.reduce_data(files, mode='sq', drpkg='geminidr', recipename=None, uparms={}, ucals={}, upload=None, config_file=None, suffix=None, logmode=None)

Map and run the requested or defaulted recipe.

5.1. Parameters

files<list> or str

The set of files to reduce, if a string it is assumed to be a single file

mode<str>

The mode of reduction: qa ql or sq, defaults to sq

drpkg :<str>

The data reduction package to map. Default is ‘geminidr’. This package must be importable.

recipename<str>

The name of the recipe or primitive to run, or None for default

uparms<dict>

The parameters for the recipes, if any

ucals<dict>

Calibration files to use, if any, as a dictionary mapping calibration type to file, None for default

upload<list>

List of types to upload, default None

config_filestr

Configuration file to use, None for default

suffixstr

Suffix to add to output file(s), None for default

logmodestr

Mode of logging such as ‘debug’, or None for default

5.1. Returns

<list> : List of files produced by the reduction

5.1.1. Subpackages

• 5.1.1.1. recipe_system.adcc package
  • 5.1.1.1.1. Subpackages
    • 5.1.1.1.1.1. recipe_system.adcc.client package
      • 5.1.1.1.1.1.1. Subpackages
      • 5.1.1.1.1.1.2. Submodules
      • 5.1.1.1.1.1.3. recipe_system.adcc.client.mock_server module
    • 5.1.1.1.1.2. recipe_system.adcc.servers package
      • 5.1.1.1.1.2.1. Submodules
      • 5.1.1.1.1.2.2. recipe_system.adcc.servers.eventsManager module
      • 5.1.1.1.1.2.3. recipe_system.adcc.servers.http_proxy module
  • 5.1.1.1.2. Submodules
  • 5.1.1.1.3. recipe_system.adcc.adcclib module
    • ADCC
      • ADCC.main()
    • Singleton
    • get_adcc_dir()
    • write_adcc_sr()
• 5.1.1.2. recipe_system.cal_service package
  • get_calconf()
  • get_db_path_from_config()
  • init_calibration_databases()
  • parse_databases()
  • set_local_database()
  • 5.1.1.2.1. Subpackages
    • 5.1.1.2.1.1. recipe_system.cal_service.tests package
      • 5.1.1.2.1.1.1. Submodules
      • 5.1.1.2.1.1.2. recipe_system.cal_service.tests.test_caldb module
      • 5.1.1.2.1.1.3. recipe_system.cal_service.tests.test_calrequestlib module
      • 5.1.1.2.1.1.4. recipe_system.cal_service.tests.test_userdb module
  • 5.1.1.2.2. Submodules
  • 5.1.1.2.3. recipe_system.cal_service.caldb module
    • CalDB
      • CalDB.add_database()
      • CalDB.clear_calibrations()
      • CalDB.get_calibrations()
      • CalDB.set_calibrations()
      • CalDB.store_calibration()
      • CalDB.unset_calibrations()
    • CalReturn
      • CalReturn.items()
    • cascade()
  • 5.1.1.2.4. recipe_system.cal_service.calrequestlib module
    • CalibrationRequest
      • CalibrationRequest.as_dict()
    • generate_md5_digest()
    • get_cal_requests()
    • get_request()
  • 5.1.1.2.5. recipe_system.cal_service.calurl_dict module
  • 5.1.1.2.6. recipe_system.cal_service.file_getter module
    • GetterError
    • get_file_iterator()
    • plain_file_getter()
    • requests_getter()
  • 5.1.1.2.7. recipe_system.cal_service.localdb module
    • LocalDB
      • LocalDB.add_cal()
      • LocalDB.add_directory()
      • LocalDB.init()
      • LocalDB.list_files()
      • LocalDB.remove_cal()
  • 5.1.1.2.8. recipe_system.cal_service.localmanager module
  • 5.1.1.2.9. recipe_system.cal_service.remotedb module
    • RemoteDB
    • retrieve_calibration()
  • 5.1.1.2.10. recipe_system.cal_service.userdb module
    • UserDB
      • UserDB.load_cache()
      • UserDB.save_cache()
• 5.1.1.3. recipe_system.mappers package
  • 5.1.1.3.1. Submodules
  • 5.1.1.3.2. recipe_system.mappers.baseMapper module
    • Mapper
  • 5.1.1.3.3. recipe_system.mappers.primitiveMapper module
    • PrimitiveMapper
      • PrimitiveMapper.get_applicable_primitives()
  • 5.1.1.3.4. recipe_system.mappers.recipeMapper module
    • RecipeMapper
      • RecipeMapper.get_applicable_recipe()
• 5.1.1.4. recipe_system.reduction package
  • 5.1.1.4.1. Subpackages
    • 5.1.1.4.1.1. recipe_system.reduction.tests package
      • 5.1.1.4.1.1.1. Submodules
      • 5.1.1.4.1.1.2. recipe_system.reduction.tests.test_coreReduce module
  • 5.1.1.4.2. Submodules
  • 5.1.1.4.3. recipe_system.reduction.coreReduce module
    • Reduce
      • Reduce.output_filenames
      • Reduce.runr()
      • Reduce.upload
    • UnrecognizedParameterException
    • reduce_data()
• 5.1.1.5. recipe_system.utils package
  • 5.1.1.5.1. Subpackages
    • 5.1.1.5.1.1. recipe_system.utils.tests package
      • 5.1.1.5.1.1.1. Submodules
      • 5.1.1.5.1.1.2. recipe_system.utils.tests.test_decorator module
      • 5.1.1.5.1.1.3. recipe_system.utils.tests.test_reduce_utils module
  • 5.1.1.5.2. Submodules
  • 5.1.1.5.3. recipe_system.utils.decorators module
  • 5.1.1.5.4. recipe_system.utils.errors module
    • AstroDataError
    • ContextError
    • ModeError
    • PrimitivesNotFound
    • RecipeNotFound
    • StackError
  • 5.1.1.5.5. recipe_system.utils.findexe module
    • findexe()
  • 5.1.1.5.6. recipe_system.utils.mapper_utils module
    • dotpath()
    • find_user_recipe()
  • 5.1.1.5.7. recipe_system.utils.md5 module
    • md5sum()
    • md5sum_size_fp()
  • 5.1.1.5.8. recipe_system.utils.reduceActions module
    • BooleanAction
    • CalibrationAction
    • ParameterAction
    • PosArgAction
    • UnitaryArgumentAction
    • UploadArgumentAction
  • 5.1.1.5.9. recipe_system.utils.reduce_utils module
    • ReduceArgumentParser
      • ReduceArgumentParser.convert_arg_line_to_args()
    • ReduceHelpFormatter
    • buildParser()
    • get_option_flags()
    • insert_option_value()
    • normalize_args()
    • normalize_ucals()
    • normalize_upload()
    • parser_has_option()
    • set_btypes()
    • show_parser_options()
  • 5.1.1.5.10. recipe_system.utils.rs_utilities module
    • log_traceback()
    • makedrpkg()

5.1.2. Submodules

5.1.3. recipe_system.config module

This module provides an interface to config files, and a globally available config object, to share setup information across the application.

An instance of ConfigParser, globalConf, is initialized when first loading this module, and it should be used as the only interface to the config system.

recipe_system.config.environment_variable_name(section, option)

recipe_system.config.expand_filenames(filenames=None, deprecation_warning=True)

Expand the list of filenames to read the config from.

5.1. Parameters

filenamesstr/list/None

filenames of config files to load, or None for default

recipe_system.config.load_config(filenames=None)

Updates the globalConf object by reading one or more config files. If no filename is passed, the default config file is read.

5.1. Parameters

filenamesstr/list/None

filenames of config files to load