API Reference Guide#
- pocket_coffea
- pocket_coffea package
- Subpackages
- pocket_coffea.executors package
- Submodules
- pocket_coffea.executors.executors_CLAIX module
- pocket_coffea.executors.executors_DESY_NAF module
- pocket_coffea.executors.executors_RWTH module
- pocket_coffea.executors.executors_T3_CH_PSI module
- pocket_coffea.executors.executors_base module
- pocket_coffea.executors.executors_brux module
- pocket_coffea.executors.executors_casa module
- pocket_coffea.executors.executors_cern_swan module
- pocket_coffea.executors.executors_infn_af module
- pocket_coffea.executors.executors_lxplus module
- pocket_coffea.executors.executors_manual_jobs module
ExecutorFactoryManualABCExecutorFactoryManualABC.close()ExecutorFactoryManualABC.customized_args()ExecutorFactoryManualABC.get()ExecutorFactoryManualABC.prepare_jobs()ExecutorFactoryManualABC.prepare_splitting()ExecutorFactoryManualABC.recreate_jobs()ExecutorFactoryManualABC.set_env()ExecutorFactoryManualABC.setup()ExecutorFactoryManualABC.setup_proxyfile()ExecutorFactoryManualABC.submit()ExecutorFactoryManualABC.submit_jobs()
ensure_job_sh_forwards_inner_yaml()ensure_sub_transfers_inner_yaml()write_inner_run_options()
- pocket_coffea.executors.executors_oscar module
- pocket_coffea.executors.executors_purdue_af module
- pocket_coffea.executors.executors_rubin module
- Module contents
- pocket_coffea.law_tasks package
- Subpackages
- pocket_coffea.law_tasks.configuration package
- Submodules
- pocket_coffea.law_tasks.configuration.general module
baseconfigdatacardconfigdatasetconfigdatasetconfig.allowlist_sitesdatasetconfig.blocklist_sitesdatasetconfig.checkdatasetconfig.dataset_definitiondatasetconfig.dataset_dirdatasetconfig.downloaddatasetconfig.include_redirectordatasetconfig.keysdatasetconfig.local_prefixdatasetconfig.overwritedatasetconfig.parallelizedatasetconfig.prioritylist_sitesdatasetconfig.regex_sitesdatasetconfig.sort_replicasdatasetconfig.split_by_year
runnerconfigtransferconfig
- pocket_coffea.law_tasks.configuration.plotting module
plottingconfigplottingconfig.blindplottingconfig.compareplottingconfig.densityplottingconfig.log_scale_xplottingconfig.log_scale_yplottingconfig.no_ratioplottingconfig.plot_dirplottingconfig.plot_formatplottingconfig.plot_styleplottingconfig.plot_systplottingconfig.plot_verboseplottingconfig.plot_workersplottingconfig.variables
plottingsystematicsconfig
- Module contents
- pocket_coffea.law_tasks.tasks package
- Submodules
- pocket_coffea.law_tasks.tasks.base module
BaseTaskBaseTask.base_storeBaseTask.exclude_indexBaseTask.exclude_params_indexBaseTask.exclude_params_reprBaseTask.exclude_params_repr_emptyBaseTask.exclude_params_reqBaseTask.exclude_params_req_getBaseTask.exclude_params_req_setBaseTask.local_directory_target()BaseTask.local_file_target()BaseTask.local_path()BaseTask.store_parts()BaseTask.versionBaseTask.version_storeBaseTask.wlcg_directory_target()BaseTask.wlcg_file_target()BaseTask.wlcg_path()
BaseTaskWithTestBaseTaskWithTest.exclude_indexBaseTaskWithTest.exclude_params_indexBaseTaskWithTest.exclude_params_reprBaseTaskWithTest.exclude_params_repr_emptyBaseTaskWithTest.exclude_params_reqBaseTaskWithTest.exclude_params_req_getBaseTaskWithTest.exclude_params_req_setBaseTaskWithTest.store_parts()BaseTaskWithTest.test
- pocket_coffea.law_tasks.tasks.datacard module
DatacardProducerDatacardProducer.categoryDatacardProducer.cfgDatacardProducer.clone_parent()DatacardProducer.clone_parents()DatacardProducer.datacard_nameDatacardProducer.exclude_indexDatacardProducer.exclude_params_indexDatacardProducer.exclude_params_reprDatacardProducer.exclude_params_repr_emptyDatacardProducer.exclude_params_reqDatacardProducer.exclude_params_req_getDatacardProducer.exclude_params_req_setDatacardProducer.output()DatacardProducer.requires()DatacardProducer.run()DatacardProducer.shapes_nameDatacardProducer.stat_configDatacardProducer.store_parts()DatacardProducer.transferDatacardProducer.variableDatacardProducer.years
- pocket_coffea.law_tasks.tasks.datasets module
CreateDatasetsCreateDatasets.allowlist_sitesCreateDatasets.blocklist_sitesCreateDatasets.cfgCreateDatasets.checkCreateDatasets.clone_parent()CreateDatasets.clone_parents()CreateDatasets.dataset_definitionCreateDatasets.dataset_dirCreateDatasets.downloadCreateDatasets.exclude_indexCreateDatasets.exclude_params_indexCreateDatasets.exclude_params_reprCreateDatasets.exclude_params_repr_emptyCreateDatasets.exclude_params_reqCreateDatasets.exclude_params_req_getCreateDatasets.exclude_params_req_setCreateDatasets.include_redirectorCreateDatasets.keysCreateDatasets.local_prefixCreateDatasets.output()CreateDatasets.overwriteCreateDatasets.parallelizeCreateDatasets.prioritylist_sitesCreateDatasets.regex_sitesCreateDatasets.run()CreateDatasets.sort_replicasCreateDatasets.split_by_year
- pocket_coffea.law_tasks.tasks.plotting module
- pocket_coffea.law_tasks.tasks.runner module
RunnerRunner.cfgRunner.clone_parent()Runner.clone_parents()Runner.coffea_outputRunner.configRunner.exclude_indexRunner.exclude_params_indexRunner.exclude_params_reprRunner.exclude_params_repr_emptyRunner.exclude_params_reqRunner.exclude_params_req_getRunner.exclude_params_req_setRunner.executorRunner.limit_chunksRunner.limit_filesRunner.output()Runner.process_separatelyRunner.requires()Runner.run()Runner.scaleoutRunner.skip_bad_filesRunner.skip_output_removalRunner.store_parts()Runner.test
- Module contents
- pocket_coffea.law_tasks.configuration package
- Submodules
- pocket_coffea.law_tasks.utils module
create_datasets_paths()exclude_samples_from_plotting()extract_executor_and_site()filter_items_by_regex()get_executor()import_analysis_config()load_analysis_config()load_plotting_style()load_run_options()load_sample_names()merge_datasets_definition()modify_dataset_output_path()process_datasets()read_datasets_definition()
- Module contents
- Subpackages
- pocket_coffea.lib package
- Subpackages
- pocket_coffea.lib.calibrators package
- Subpackages
- Submodules
- pocket_coffea.lib.calibrators.calibrator module
- pocket_coffea.lib.calibrators.calibrators_manager module
- Module contents
- pocket_coffea.lib.weights package
- Subpackages
- Submodules
- pocket_coffea.lib.weights.test_weights_mechanism module
- pocket_coffea.lib.weights.weights module
- pocket_coffea.lib.weights.weights_manager module
- Module contents
- pocket_coffea.lib.calibrators package
- Submodules
- pocket_coffea.lib.categorization module
- pocket_coffea.lib.columns_manager module
- pocket_coffea.lib.cut_definition module
- pocket_coffea.lib.cut_functions module
apply_event_flags()apply_golden_json()count_objects_eq()count_objects_gt()count_objects_lt()eq_nObj()eq_nObj_minPt()get_HLTsel()get_HLTsel_custom()get_JetVetoMap()get_JetVetoMap_Mask()get_L1sel()get_L1sel_custom()get_nBtag()get_nBtagEq()get_nBtagMin()get_nElectron()get_nMuon()get_nObj_eq()get_nObj_less()get_nObj_min()get_nPVgood()less_nObj()min_nObj()min_nObj_minPt()nBtagEq()nBtagMin()nElectron()nMuon()passthrough_f()
- pocket_coffea.lib.delayed_eval module
- pocket_coffea.lib.deltaR_matching module
- pocket_coffea.lib.gen_objects module
- pocket_coffea.lib.hist_manager module
AxisHistConfHistConf.autofillHistConf.axesHistConf.collapse_2D_masksHistConf.collapse_2D_masks_modeHistConf.exclude_categoriesHistConf.exclude_samplesHistConf.hist_objHistConf.metadata_histHistConf.no_weightsHistConf.only_categoriesHistConf.only_samplesHistConf.only_variationsHistConf.serialize()HistConf.storageHistConf.variations
HistManagerget_hist_axis_from_config()weights_cache()
- pocket_coffea.lib.jets module
CCsorted()CvsLsorted()ProbBsorted()add_jec_variables()add_jec_variables_subjet()btagging()compute_jetId()get_dijet()get_jer_correction_set()get_jersmear()get_rho()jet_correction_corrlib()jet_selection()load_jet_factory()met_correction()met_correction_after_jec()met_xy_correction()msoftdrop_correction()
- pocket_coffea.lib.leptons module
- pocket_coffea.lib.muon_scale_and_resolution module
- pocket_coffea.lib.objects module
- pocket_coffea.lib.parton_provenance module
- pocket_coffea.lib.photon module
- pocket_coffea.lib.reconstruction module
- pocket_coffea.lib.scale_factors module
- pocket_coffea.lib.triggers module
- Module contents
- Subpackages
- pocket_coffea.parameters package
- pocket_coffea.scripts package
- Subpackages
- pocket_coffea.scripts.dataset package
- Submodules
- pocket_coffea.scripts.dataset.append_genweights module
- pocket_coffea.scripts.dataset.append_parents module
- pocket_coffea.scripts.dataset.build_datasets module
- pocket_coffea.scripts.dataset.dataset_query module
DataDiscoveryCLIDataDiscoveryCLI.as_dictDataDiscoveryCLI.do_allowlist_sites()DataDiscoveryCLI.do_blocklist_sites()DataDiscoveryCLI.do_clear()DataDiscoveryCLI.do_list_replicas()DataDiscoveryCLI.do_list_selected()DataDiscoveryCLI.do_login()DataDiscoveryCLI.do_prioritylist_sites()DataDiscoveryCLI.do_query()DataDiscoveryCLI.do_query_results()DataDiscoveryCLI.do_regex_sites()DataDiscoveryCLI.do_replicas()DataDiscoveryCLI.do_save()DataDiscoveryCLI.do_select()DataDiscoveryCLI.do_set_replicas_sorting()DataDiscoveryCLI.do_sites_filters()DataDiscoveryCLI.do_whoami()DataDiscoveryCLI.extract_era_from_dataset_name()DataDiscoveryCLI.extract_xsec_from_dataset_name()DataDiscoveryCLI.extract_year_from_dataset_name()DataDiscoveryCLI.generate_default_metadata()DataDiscoveryCLI.is_mc_dataset()DataDiscoveryCLI.load_dataset_definition()DataDiscoveryCLI.start_cli()
get_indices_query()print_dataset_query()
- pocket_coffea.scripts.dataset.download module
- Module contents
- pocket_coffea.scripts.plot package
- pocket_coffea.scripts.dataset package
- Submodules
- pocket_coffea.scripts.build_jec module
- pocket_coffea.scripts.check_jobs module
- pocket_coffea.scripts.config_template module
- pocket_coffea.scripts.hadd_skimmed_files module
- pocket_coffea.scripts.make_config module
- pocket_coffea.scripts.merge_columns module
- pocket_coffea.scripts.merge_outputs module
- pocket_coffea.scripts.pileup_corrlib module
- pocket_coffea.scripts.print_parameters module
- pocket_coffea.scripts.runner module
- pocket_coffea.scripts.split_output module
- Module contents
- Subpackages
- pocket_coffea.utils package
- Subpackages
- pocket_coffea.utils.stat package
- Submodules
- pocket_coffea.utils.stat.combine module
DatacardDatacard.adjust_columnsDatacard.adjust_first_columnDatacard.adjust_syst_columDatacard.binDatacard.content()Datacard.create_shape_histogram_dict()Datacard.dump()Datacard.expectation_section()Datacard.get_datasets_by_sample()Datacard.imaxDatacard.is_empty_dataset()Datacard.jmaxDatacard.kmaxDatacard.mcstat_configDatacard.mcstat_section()Datacard.observationDatacard.observation_section()Datacard.preamble()Datacard.rate()Datacard.rate_parameters_section()Datacard.rearrange_histograms()Datacard.shape_section()Datacard.shape_variationsDatacard.systematics_section()
combine_datacards()
- pocket_coffea.utils.stat.processes module
- pocket_coffea.utils.stat.systematics module
- Module contents
DataProcessDataProcessesDatacardDatacard.adjust_columnsDatacard.adjust_first_columnDatacard.adjust_syst_columDatacard.binDatacard.content()Datacard.create_shape_histogram_dict()Datacard.dump()Datacard.expectation_section()Datacard.get_datasets_by_sample()Datacard.imaxDatacard.is_empty_dataset()Datacard.jmaxDatacard.kmaxDatacard.mcstat_configDatacard.mcstat_section()Datacard.observationDatacard.observation_section()Datacard.preamble()Datacard.rate()Datacard.rate_parameters_section()Datacard.rearrange_histograms()Datacard.shape_section()Datacard.shape_variationsDatacard.systematics_section()
MCProcessMCProcessesSystematicUncertaintySystematics
- pocket_coffea.utils.stat package
- Submodules
- pocket_coffea.utils.benchmarking module
- pocket_coffea.utils.build_jets_calibrator module
- pocket_coffea.utils.configurator module
ConfiguratorConfigurator.clone()Configurator.filter_dataset()Configurator.load()Configurator.load_columns_config()Configurator.load_cuts_and_categories()Configurator.load_datasets()Configurator.load_subsamples()Configurator.load_variations_config()Configurator.load_weights_config()Configurator.load_workflow()Configurator.perform_checks()Configurator.save_config()Configurator.set_filesets_manually()
format()
- pocket_coffea.utils.cutflow_utils module
- pocket_coffea.utils.dataset module
- pocket_coffea.utils.export module
- pocket_coffea.utils.filter_output module
- pocket_coffea.utils.histogram module
- pocket_coffea.utils.load_output module
- pocket_coffea.utils.logging module
- pocket_coffea.utils.network module
- pocket_coffea.utils.plot_efficiency module
EfficiencyMapEfficiencyMap.compute_efficiency()EfficiencyMap.define_1d_figures()EfficiencyMap.define_datamc()EfficiencyMap.define_systematics()EfficiencyMap.define_variations()EfficiencyMap.initialize_stack()EfficiencyMap.plot1d()EfficiencyMap.plot2d()EfficiencyMap.save1d()EfficiencyMap.save2d()EfficiencyMap.save_corrections()
plot_efficiency_maps()plot_efficiency_maps_splitHT()plot_efficiency_maps_spliteras()plot_ratio()plot_residue()plot_variation()stack_sum()uncertainty_efficiency()uncertainty_sf()
- pocket_coffea.utils.plot_functions module
- pocket_coffea.utils.plot_sf module
- pocket_coffea.utils.plot_utils module
- pocket_coffea.utils.rucio module
- pocket_coffea.utils.run module
- pocket_coffea.utils.skim module
- pocket_coffea.utils.time module
- pocket_coffea.utils.utils module
- Module contents
- Subpackages
- pocket_coffea.workflows package
- Submodules
- pocket_coffea.workflows.base module
BaseProcessorABCBaseProcessorABC.apply_object_preselection()BaseProcessorABC.apply_preselections()BaseProcessorABC.compute_weights()BaseProcessorABC.compute_weights_extra()BaseProcessorABC.count_events()BaseProcessorABC.count_objects()BaseProcessorABC.define_categories()BaseProcessorABC.define_column_accumulators()BaseProcessorABC.define_column_accumulators_extra()BaseProcessorABC.define_common_variables_after_presel()BaseProcessorABC.define_common_variables_before_presel()BaseProcessorABC.define_custom_axes_extra()BaseProcessorABC.define_histograms()BaseProcessorABC.define_histograms_extra()BaseProcessorABC.define_weights()BaseProcessorABC.export_skimmed_chunk()BaseProcessorABC.fill_column_accumulators()BaseProcessorABC.fill_column_accumulators_extra()BaseProcessorABC.fill_histograms()BaseProcessorABC.fill_histograms_extra()BaseProcessorABC.get_preselection_mask()BaseProcessorABC.initialize_calibrators()BaseProcessorABC.load_metadata()BaseProcessorABC.load_metadata_extra()BaseProcessorABC.loop_over_variations()BaseProcessorABC.neventsBaseProcessorABC.postprocess()BaseProcessorABC.process()BaseProcessorABC.process_extra_after_calibrators()BaseProcessorABC.process_extra_after_presel()BaseProcessorABC.process_extra_after_skim()BaseProcessorABC.process_extra_before_presel()BaseProcessorABC.process_extra_before_skim()BaseProcessorABC.rescale_sumgenweights()BaseProcessorABC.save_processing_metadata()BaseProcessorABC.skim_events()
- pocket_coffea.workflows.genweights module
- pocket_coffea.workflows.semileptonic_triggerSF module
- pocket_coffea.workflows.sf_lepton_variations module
- pocket_coffea.workflows.tthbb_base_processor module
- Module contents
- pocket_coffea.executors package
- Module contents
- Subpackages
- pocket_coffea package