frame_cli package

Subpackages

• frame_cli.downloaders package
  • Submodules
    • frame_cli.downloaders.dlhub module
    • frame_cli.downloaders.downloader module
      • Downloader
    • frame_cli.downloaders.git module
      • GitDownloader
    • frame_cli.downloaders.hydroshare module
      • HydroshareDownloader
      • _check_url()
      • _download_archive()
    • frame_cli.downloaders.zenodo module
      • ZenodoDownloader
      • ZenodoError
      • _check_request_response()
      • _download_file()
      • _download_files()
      • _get_host_and_id_from_url()
      • handle_sigint()
  • Module contents

Submodules

• frame_cli.check module
  • check()
  • check_api()
  • check_git()
  • check_uv()
• frame_cli.config module
• frame_cli.info module
  • add_local_model_info()
  • get_closest_info_path()
  • get_github_token()
  • get_global_info()
  • get_home_info_path()
  • get_local_model_info()
  • get_local_models_info()
  • set_global_info()
  • set_local_model_info()
• frame_cli.init module
  • init()
• frame_cli.listing module
  • ComponentType
    • ComponentType.machine_learning
    • ComponentType.physics_based
  • list_local_models()
  • list_remote_components()
  • list_remote_models()
• frame_cli.logging module
• frame_cli.main module
  • check()
  • init()
  • list_components()
  • list_models()
  • main()
  • pull_component()
  • pull_model()
  • push()
  • show_component()
  • show_model()
  • update()
  • validate()
  • version()
  • version_callback()
• frame_cli.metadata module
  • InvalidMetadataFileError
  • MetadataFileAlreadyExistsError
  • MetadataFileNotFoundError
  • MetadataTemplateFetchError
  • NotInsideGitRepositoryError
  • create_metadata_file()
  • get_metadata()
  • get_metadata_file_path()
  • get_model_name()
  • get_model_url()
  • metadata_file_exists()
  • show_fair_level()
  • validate()
• frame_cli.pull module
  • pull_component()
  • pull_metadata_file()
  • pull_model()
  • setup_environment()
• frame_cli.push module
  • MissingModelURLError
  • ModelAlreadyIntegratedError
  • ModelAlreadyTrackedError
  • add_model_to_local_frame_repo()
  • add_model_to_local_frame_repo_as_integrated()
  • add_model_to_local_frame_repo_as_reference()
  • create_frame_fork()
  • create_pull_request()
  • generate_branch_name()
  • get_local_frame_repo()
  • get_model_name()
  • get_model_url()
  • push()
  • push_to_frame_fork()
  • validate_integration()
• frame_cli.show module
  • print_keywords()
  • print_pull_command()
  • show_remote_component()
  • show_remote_model()
• frame_cli.update module
  • CannotInstallFRAMEAPIError
  • install_api_package()
  • update()
• frame_cli.utils module
  • get_unit_id_and_version()
  • retrieve_component_info()
  • retrieve_model_info()

Module contents

Command line interface for managing FRAME hybrid models