Skip to content

cli

clear()

Clear the local dataset cache

Source code in pyhdx/cli.py 
94
95
96
97
98
@datasets_app.command()
def clear():
    """Clear the local dataset cache"""
    vault = DataVault(cache_dir=cfg.database_dir)
    vault.clear_cache()

fetch(num=typer.Option(10, min=1, help='Maximum number of datasets to download'))

Update the datasets from the PyHDX repository

Source code in pyhdx/cli.py 
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
@datasets_app.command()
def fetch(num: int = typer.Option(10, min=1, help="Maximum number of datasets to download")):
    """Update the datasets from the PyHDX repository"""
    vault = DataVault(cache_dir=cfg.database_dir)
    missing_datasets = list(set(vault.remote_index) - set(vault.datasets))
    missing_datasets = [data_id for data_id in missing_datasets if data_id]

    failed = []
    success = []
    if missing_datasets:
        todo = list(missing_datasets)[:num]
        for data_id in tqdm(todo):
            try:
                vault.fetch_dataset(data_id)
                success.append(data_id)
            except Exception:
                failed.append(data_id)
    else:
        print("All datasets already downloaded")

    if failed:
        print(f"Failed to download: {', '.join(failed)}")
    if success:
        print(f"Downloaded: {', '.join(success)}")

serve(scheduler_address=typer.Option(None, help='Address for dask scheduler to use'), config=typer.Option(None, exists=True, help='Optional PyHDX .yaml config file to use'))

Launch the PyHDX web application

Source code in pyhdx/cli.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
@app.command()
def serve(
    scheduler_address: Optional[str] = typer.Option(None, help="Address for dask scheduler to use"),
    config: Optional[Path] = typer.Option(
        None, exists=True, help="Optional PyHDX .yaml config file to use"
    ),
):
    """Launch the PyHDX web application"""

    from pyhdx.config import cfg
    from pyhdx.local_cluster import default_cluster, verify_cluster

    if config is not None:
        conf = OmegaConf.create(config.read_text())
        cfg.set_config(conf)

    if scheduler_address is not None:
        ip, port = scheduler_address.split(":")
        if not ip_address(ip):
            print("Invalid IP Address")
            return
        elif not 0 <= int(port) < 2**16:
            print("Invalid port, must be 0-65535")
            return
        cfg.cluster.scheduler_address = scheduler_address

    scheduler_address = cfg.cluster.scheduler_address
    if not verify_cluster(scheduler_address):
        # Start a new local cluster if none is found
        client = default_cluster()
        _, ip, port = client.scheduler_address.split(":")
        ip = ip.strip("/")
        scheduler_address = f"{ip}:{port}"
        print(f"Started new Dask LocalCluster at {scheduler_address}")

    # Start the PyHDX web application
    from pyhdx.web import serve as serve_pyhdx

    serve_pyhdx.run_apps()

    loop = True
    while loop:
        try:
            time.sleep(1)
        except KeyboardInterrupt:
            print("Interrupted")
            loop = False