mirar.downloader package

Submodules

mirar.downloader.caltech module

Module for downloading data from caltech machines

mirar.downloader.caltech.download_via_ssh(server: str, base_dir: str | Path, night: str | int, pipeline: str, prefix: str = '', server_sub_dir: str | None = None, username: str | None = None)[source]

Function to download data via rsync+ssh from a caltech machine

Parameters:
  • server – host server

  • base_dir – base directory on host server

  • night – night of data to download

  • pipeline – instrument to download

  • prefix – prefix for server data directory

  • server_sub_dir – subdirectory within night directory on server

  • username – username to use for ssh

Returns:

None

mirar.downloader.get_test_data module

Module handling the downloading of test data

mirar.downloader.get_test_data.completed_testdata_check() bool[source]

Returns a boolean for whether the test data was already checked

Returns:

Bool

mirar.downloader.get_test_data.do_testdata_check() bool[source]

Returns a boolean for whether the test data needs to be checked

Returns:

Bool

mirar.downloader.get_test_data.get_test_data_dir() Path[source]

Returns the local path of the test data directory

Returns:

None

mirar.downloader.get_test_data.require_test_data()[source]

Function to set the test data to be required

Returns:

None

mirar.downloader.get_test_data.update_test_data()[source]

Updates the test data by fetching the latest version with git, and then checking out the specific tagged version

Returns:

None