Skip to content
  • Code Reference
  • careamics_portfolio
  • utils
  • download_utils

download_utils

get_poochfolio(path=None) #

Create the pooch object for the whole portfolio.

By default the files will be downloaded and cached in the user's cache folder and can be retrieved automatically without downloading the file anew (thanks pooch!).

Attributes:

Name Type Description
path Path

Path to the folder in which to download the dataset. Defaults to None.

Returns:

Type Description
Pooch

Pooch object for the whole portfolio.
Source code in src/careamics_portfolio/utils/download_utils.py 
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
def get_poochfolio(path: Optional[Union[str, Path]] = None) -> Pooch:
    """Create the pooch object for the whole portfolio.

    By default the files will be downloaded and cached in the user's
    cache folder and can be retrieved automatically without downloading
    the file anew (thanks pooch!).


    Attributes
    ----------
    path : Path
        Path to the folder in which to download the dataset. Defaults to None.

    Returns
    -------
    Pooch
        Pooch object for the whole portfolio.

    """
    if path is None:
        path = pooch.os_cache("portfolio")

    poochfolio = pooch.create(
        path=path,
        base_url="",
    )

    # Path to the registry.txt file
    poochfolio.load_registry(get_registry_path())

    return poochfolio

get_registry_path() #

Get the path to the registry.txt file.

Returns:

Type Description
Path

Path to the registry.txt file.
Source code in src/careamics_portfolio/utils/download_utils.py 
 8
 9
10
11
12
13
14
15
16
def get_registry_path() -> Path:
    """Get the path to the registry.txt file.

    Returns
    -------
    Path
        Path to the registry.txt file.
    """
    return Path(__file__).parent / "../registry/registry.txt"