API Documentation

• UCore
  • append_query_to_uri()
  • calculate_file_hash()
  • calculate_string_hash()
  • clean_up_scratch_space()
  • folder_has_uparam_signature()
  • shutdown_local_upi_servers()
  • shutdown_telemetry()
• UConvert Classes
  • JSONEncoder
    • JSONEncoder.default()
  • JSONDecoder
    • JSONDecoder.__init__()
    • JSONDecoder.object_hook()
• UCredentialManager Class
  • UCredentialManager
    • UCredentialManager.__init__()
    • UCredentialManager.add_credentials()
    • UCredentialManager.extract_credentials()
    • UCredentialManager.format_cred_key()
    • UCredentialManager.get_password()
    • UCredentialManager.get_user()
    • UCredentialManager.ingest_cred_entry()
    • UCredentialManager.init_io_class()
    • UCredentialManager.io
    • UCredentialManager.read_credentials()
    • UCredentialManager.validate_credential_entry()
    • UCredentialManager.write_credentials()
• UCredentials IO Classes
  • IOBaseCreds
    • IOBaseCreds.__init__()
    • IOBaseCreds.get_secret()
  • IOAzureCreds
    • IOAzureCreds.__init__()
    • IOAzureCreds.get_secret()
  • IOGCPCreds
    • IOGCPCreds.__init__()
    • IOGCPCreds.get_secret()
  • IOEnvCreds
    • IOEnvCreds.__init__()
    • IOEnvCreds.get_secret()
  • IOEchoCreds
    • IOEchoCreds.__init__()
    • IOEchoCreds.get_secret()
• UCtl
  • create_app()
  • get_all_relevant_nodes()
  • homepage()
  • launch_dashboard()
  • logger
  • run_mcp_server()
  • run_server()
  • run_unode_in_loop()
  • send_signal_to_pid()
  • start_mcp_server()
  • describe_last_runs()
  • describe_node_ex_id()
  • describe_object_name()
  • describe_ucfs()
  • describe_wid()
  • log_table()
  • get_status()
  • upload_folder()
  • set_config()
  • set_credentials()
  • show_config()
  • show_credentials()
• UFile Class
  • UFile
    • UFile.__init__()
    • UFile.__repr__()
    • UFile.__eq__()
    • UFile.__lt__()
    • UFile.__deepcopy__()
    • UFile.as_storage_base_uri()
    • UFile.as_uri()
    • UFile.check_uri_scheme_exists()
    • UFile.compress()
    • UFile.create_container()
    • UFile.create_lineage_graph()
    • UFile.download()
    • UFile.format_uri()
    • UFile.from_path_object()
    • UFile.get_object()
    • UFile.guess_uftype_from_suffix()
    • UFile.hash
    • UFile.identify_lineage_root_files()
    • UFile.init_io_class()
    • UFile.io
    • UFile.is_borg
    • UFile.is_part_of_collection
    • UFile.list_container_items()
    • UFile.object_name
    • UFile.parents
    • UFile.path
    • UFile.provenance
    • UFile.purge_local()
    • UFile.purge_local_file()
    • UFile.purge_local_tags()
    • UFile.rebase()
    • UFile.recalculate_hashes()
    • UFile.relocate_fragment_to_path()
    • UFile.remote_object_exists()
    • UFile.remove_remote_object()
    • UFile.simple_name
    • UFile.simplify_name()
    • UFile.storage_base_uri
    • UFile.tags
    • UFile.ucfs
    • UFile.uftype
    • UFile.uncompress()
    • UFile.upload()
• UUriDict Class
  • UUri
    • UUri.__init__()
    • UUri.azure_directory_list
    • UUri.azure_object_directory_list
    • UUri.azure_object_file
    • UUri.azure_share
    • UUri.check_fragment_integrity()
    • UUri.container_name
    • UUri.file_remote_path
    • UUri.file_remote_tag_path
    • UUri.get_azure_directory_list()
    • UUri.get_azure_object_directory_list()
    • UUri.get_azure_object_file()
    • UUri.get_azure_share()
    • UUri.get_container_name()
    • UUri.get_file_remote_path()
    • UUri.get_file_remote_tag_path()
    • UUri.get_github_resource_name()
    • UUri.get_host()
    • UUri.get_https_remote_path()
    • UUri.get_https_remote_tag_path()
    • UUri.get_mylabdata_api_url()
    • UUri.get_mylabdata_api_url_files()
    • UUri.get_mylabdata_url()
    • UUri.get_object_name()
    • UUri.get_port()
    • UUri.get_samba_share()
    • UUri.github_resource_name
    • UUri.host
    • UUri.https_remote_path
    • UUri.https_remote_tag_path
    • UUri.mylabdata_api_url
    • UUri.mylabdata_api_url_files
    • UUri.mylabdata_url
    • UUri.object_name
    • UUri.parse_query_tags()
    • UUri.password
    • UUri.port
    • UUri.samba_share
    • UUri.storage_uri
    • UUri.user
• UFile IO Classes
  • UIOBase
    • UIOBase.__init__()
    • UIOBase.add_storage_uri_to_container_items()
    • UIOBase.download()
    • UIOBase.local_object_exists()
    • UIOBase.scratch_path
    • UIOBase.upload()
  • IOAzureBlobStorage
    • IOAzureBlobStorage.__init__()
    • IOAzureBlobStorage.download()
    • IOAzureBlobStorage.get_file_properties()
    • IOAzureBlobStorage.get_remote_tags()
    • IOAzureBlobStorage.is_within_date_range()
    • IOAzureBlobStorage.list_container_items()
    • IOAzureBlobStorage.remote_object_exists()
    • IOAzureBlobStorage.remote_path
    • IOAzureBlobStorage.remote_tag_path
    • IOAzureBlobStorage.upload()
  • IOPython
    • IOPython.__init__()
    • IOPython.create_container()
    • IOPython.download()
    • IOPython.get_object()
    • IOPython.get_remote_tags()
    • IOPython.list_container_items()
    • IOPython.remote_object_exists()
    • IOPython.remove_remote_object()
    • IOPython.upload()
  • IOGoogleCloudStorage
    • IOGoogleCloudStorage.__init__()
    • IOGoogleCloudStorage.download()
    • IOGoogleCloudStorage.get_remote_tags()
    • IOGoogleCloudStorage.list_container_items()
    • IOGoogleCloudStorage.remote_object_exists()
    • IOGoogleCloudStorage.remote_path
    • IOGoogleCloudStorage.remote_tag_path
    • IOGoogleCloudStorage.upload()
  • IOHTTPS
    • IOHTTPS.__init__()
    • IOHTTPS.download()
    • IOHTTPS.get_object()
    • IOHTTPS.get_remote_tags()
    • IOHTTPS.remote_object_exists()
    • IOHTTPS.upload()
• UFileList Class
  • UFileList
    • UFileList.__init__()
    • UFileList.__setitem__()
    • UFileList.__add__()
    • UFileList.__radd__()
    • UFileList.__iadd__()
    • UFileList.add_ufile()
    • UFileList.all_remote_files_exist
    • UFileList.append()
    • UFileList.as_uri_list()
    • UFileList.assign_uftype_to_ufiles()
    • UFileList.calculate_ucfs()
    • UFileList.check_input_uftype_count()
    • UFileList.check_tags_on_ufile_for_uftype()
    • UFileList.complete_file_counts()
    • UFileList.create_flat_and_non_redundant_list()
    • UFileList.download_ufiles()
    • UFileList.extend_by_uftype()
    • UFileList.filter()
    • UFileList.from_folder()
    • UFileList.from_uri_list()
    • UFileList.get_index_groups_by_tag()
    • UFileList.get_index_groups_by_uftypes()
    • UFileList.get_indices_by_uftype()
    • UFileList.get_indices_matching_tag()
    • UFileList.get_path_object_groups_by_uftypes()
    • UFileList.get_path_objects_by_uftype()
    • UFileList.get_storage_base_uris()
    • UFileList.id
    • UFileList.insert()
    • UFileList.keep_uftypes()
    • UFileList.number_of_uftypes()
    • UFileList.relocate_fragment_to_path()
    • UFileList.remove_uftypes()
    • UFileList.set_uftypes_if_none_available()
    • UFileList.simplify_names()
    • UFileList.uncompress()
    • UFileList.upload_ufiles()
• UHelpers Classes
  • Concat
    • Concat.process()
  • FilterByUftype
    • FilterByUftype.process()
  • OutputRenamer
    • OutputRenamer.process()
  • UrgapNodeExecutor
    • UrgapNodeExecutor.finish_bundle()
    • UrgapNodeExecutor.process()
    • UrgapNodeExecutor.setup()
    • UrgapNodeExecutor.start_bundle()
    • UrgapNodeExecutor.teardown()
  • flatten_to_list()
  • generate_pyvis_network()
  • parse_inputs()
  • filter_by_uftype()
  • flatten_no_strings()
  • group_by_tag()
  • import_flow()
  • parse_inputs()
  • rebase()
  • retrieve_processed_uris()
  • run_unode()
  • setup_urgap()
  • simplify_output_names()
• UInit
  • configure_logger()
  • copy_config_if_needed()
  • copy_resources_if_needed()
  • create_home_folder()
  • load_certificates()
  • read_config()
  • set_scratch_disk_path()
  • show_banner()
• UMeta Class
  • UMeta
    • UMeta.__init__()
    • UMeta.delete()
    • UMeta.find_last_processed_files()
    • UMeta.find_pac_id_details()
    • UMeta.find_pac_ids()
    • UMeta.find_pac_ids_of_consumers()
    • UMeta.find_pac_ids_of_producers()
    • UMeta.find_wid_members()
    • UMeta.get_ucfs_object_name_info()
    • UMeta.init_io_class()
    • UMeta.io
    • UMeta.load_history()
    • UMeta.load_node_exe_details()
    • UMeta.load_utrace()
    • UMeta.retrieve_interface_statistics()
    • UMeta.save_rebased_file_to_ucfs_storage_location()
    • UMeta.save_utrace()
    • UMeta.umeta_exists()
• UMeta IO Classes
  • UMetaIOBase
    • UMetaIOBase.__init__()
    • UMetaIOBase.__deepcopy__()
    • UMetaIOBase.find_last_processed_files()
    • UMetaIOBase.find_pac_id_details()
    • UMetaIOBase.find_pac_ids()
    • UMetaIOBase.find_pac_ids_of_consumers()
    • UMetaIOBase.find_pac_ids_of_producers()
    • UMetaIOBase.find_wid_members()
    • UMetaIOBase.load()
    • UMetaIOBase.retrieve_interface_statistics()
    • UMetaIOBase.save()
  • UcfsStorageLocation
  • ExecutionConfigurations
  • InputUFiles
  • OutputUFiles
  • ExecutionInputLink
  • ExecutionOutputLink
  • ExecutionHistory
  • UserDicts
  • SQLAlchemyBaseUMeta
    • SQLAlchemyBaseUMeta.__init__()
    • SQLAlchemyBaseUMeta.db
    • SQLAlchemyBaseUMeta.find_pac_ids()
    • SQLAlchemyBaseUMeta.find_pac_ids_of_consumers()
    • SQLAlchemyBaseUMeta.find_pac_ids_of_producers()
    • SQLAlchemyBaseUMeta.find_wid_members()
    • SQLAlchemyBaseUMeta.generate_connection_string()
    • SQLAlchemyBaseUMeta.get_execution_status()
    • SQLAlchemyBaseUMeta.get_ucfs_object_name_info()
    • SQLAlchemyBaseUMeta.load_history()
    • SQLAlchemyBaseUMeta.load_links()
    • SQLAlchemyBaseUMeta.load_node_exe_details()
    • SQLAlchemyBaseUMeta.retrieve_interface_statistics()
    • SQLAlchemyBaseUMeta.save()
    • SQLAlchemyBaseUMeta.save_rebased_file_to_ucfs_storage_location()
    • SQLAlchemyBaseUMeta.umeta_exists()
  • UMeta
    • UMeta.__init__()
    • UMeta.load()
    • UMeta.save()
    • UMeta.umeta_exists()
  • UMeta
    • UMeta.__init__()
    • UMeta.generate_connection_string()
  • UMeta
    • UMeta.__init__()
    • UMeta.generate_connection_string()
  • UMeta
    • UMeta.__init__()
    • UMeta.generate_connection_string()
• UNode Class
  • UNodeBase
    • UNodeBase.__init__()
    • UNodeBase.check_if_all_exe_exist()
    • UNodeBase.construct_exe_path()
    • UNodeBase.delete_tmp_files()
    • UNodeBase.exe_path
    • UNodeBase.execute()
    • UNodeBase.execute_rerun()
    • UNodeBase.generate_node_vis()
    • UNodeBase.get_comp_arch()
    • UNodeBase.has_all_required_installations()
    • UNodeBase.install_resource()
    • UNodeBase.is_available
    • UNodeBase.remove_output_folder()
    • UNodeBase.remove_umeta()
    • UNodeBase.required_3rd_party_installation
    • UNodeBase.requires_3rd_party_installation
    • UNodeBase.resource_is_available
    • UNodeBase.resource_subfolder
    • UNodeBase.run()
    • UNodeBase.run_node_as_mcp_tool()
• UNodeManager Class
  • UNodeManager
    • UNodeManager.__init__()
    • UNodeManager.assign_unode_ports()
    • UNodeManager.check_requirements()
    • UNodeManager.check_unode_dependencies()
    • UNodeManager.generate_wrapper_lookup()
    • UNodeManager.import_class()
    • UNodeManager.init_unode()
• UReport Class
  • UReport
    • UReport.__init__()
    • UReport.__repr__()
    • UReport.crashed()
    • UReport.data_exists()
    • UReport.draw_execution_dag()
    • UReport.find_root_files()
    • UReport.generate_node_vis()
    • UReport.generate_report()
    • UReport.get_trace()
    • UReport.graph
    • UReport.meta_data_exists()
    • UReport.pac_ids
    • UReport.query_node_outputs_by_aliases()
    • UReport.render_report()
    • UReport.summary()
    • UReport.umeta
    • UReport.walk()
    • UReport.was_run()
    • UReport.was_skipped()
    • UReport.wids
• URunDict Class
  • URunDict
    • URunDict.__init__()
    • URunDict.assign_wid()
    • URunDict.command_list
    • URunDict.determine_output_files_stem()
    • URunDict.input_files
    • URunDict.meta_info
    • URunDict.output_files
    • URunDict.parameters
    • URunDict.params_hash
    • URunDict.reassign_wid()
    • URunDict.register_unode_meta_info()
    • URunDict.rerun_params_hash
    • URunDict.unode_parameters
    • URunDict.unode_rinfo
    • URunDict.user_dict
    • URunDict.wid
• UTelemetry Class
  • UTelemetry
    • UTelemetry.__init__()
    • UTelemetry.add_span_event()
    • UTelemetry.add_span_events()
    • UTelemetry.close_span()
    • UTelemetry.end_all_spans()
    • UTelemetry.find_span()
    • UTelemetry.increase_counter()
    • UTelemetry.increase_counters()
    • UTelemetry.init_meter()
    • UTelemetry.init_span()
    • UTelemetry.init_tracer()
    • UTelemetry.meter
    • UTelemetry.otlp_type
    • UTelemetry.otlp_url
    • UTelemetry.set_span_attribute()
    • UTelemetry.set_span_attributes()
    • UTelemetry.set_span_status()
    • UTelemetry.shutdown()
    • UTelemetry.tracer
    • UTelemetry.tracing_enabled
    • UTelemetry.utl_trace()
• Util
  • execute_threaded_function()
  • extract_from_string()
  • get_next_port()
  • sense_compression_format()
  • sort_versions()
• UTrace Class
  • UTrace
    • UTrace.__init__()
    • UTrace.add_execution_record()
    • UTrace.crashed
    • UTrace.determine_output_files_stem()
    • UTrace.evaluate_if_rerun_is_required()
    • UTrace.evaluate_retain_uftype()
    • UTrace.execution_time
    • UTrace.extend_output_files_by_uftype()
    • UTrace.filter_input_files()
    • UTrace.fix_dynamic_output_file_names()
    • UTrace.get_output_file_uri()
    • UTrace.get_parent_files()
    • UTrace.get_parent_hashes()
    • UTrace.id
    • UTrace.info()
    • UTrace.init_from_umeta_entries()
    • UTrace.load_from_umeta()
    • UTrace.move_output_files()
    • UTrace.output_base_storage_uri
    • UTrace.output_files_stem
    • UTrace.pac_id
    • UTrace.populate_minimal_output_file_list()
    • UTrace.remote_output_files
    • UTrace.save_umeta_information()
    • UTrace.set_start_time()
    • UTrace.set_stop_time()
    • UTrace.umeta
    • UTrace.upload_output_files()
    • UTrace.was_run
    • UTrace.was_skipped
    • UTrace.wid
• UTree Class
  • UTreeQuerier
    • UTreeQuerier.__init__()
    • UTreeQuerier.get_leafs_from_node()
    • UTreeQuerier.get_nodes_with_ext()
    • UTreeQuerier.get_subgraph()
    • UTreeQuerier.get_uftype_or_closest_any()
    • UTreeQuerier.to_root()
  • Uftypes Namespace Structure
• UWid Class
  • UWIDGenerator
    • UWIDGenerator.__init__()
    • UWIDGenerator.__iter__()
    • UWIDGenerator.__next__()
    • UWIDGenerator.generate_wid()
    • UWIDGenerator.n