Caching Functions¶

Get the brahe cache directory path.

The cache directory is determined by the BRAHE_CACHE environment variable. If not set, defaults to ~/.cache/brahe.

The directory is created if it doesn't exist.

Returns:

Raises:

1
2
3
4
5
6
7
8
9

import brahe as bh

cache_dir = bh.get_brahe_cache_dir()
print(f"Cache directory: {cache_dir}")

# You can also override with environment variable
import os
os.environ['BRAHE_CACHE'] = '/custom/cache/path'
cache_dir = bh.get_brahe_cache_dir()

Get the brahe cache directory path with an optional subdirectory.

The cache directory is determined by the BRAHE_CACHE environment variable. If not set, defaults to ~/.cache/brahe. If a subdirectory is provided, it is appended to the cache path.

The directory is created if it doesn't exist.

Parameters:

Returns:

Raises:

1
2
3
4
5
6
7
8
9

import brahe as bh

# Get main cache directory
cache_dir = bh.get_brahe_cache_dir_with_subdir(None)
print(f"Cache: {cache_dir}")

# Get custom subdirectory
custom_cache = bh.get_brahe_cache_dir_with_subdir("my_data")
print(f"Custom cache: {custom_cache}")

Get the EOP cache directory path.

Returns the path to the EOP (Earth Orientation Parameters) cache subdirectory. Defaults to ~/.cache/brahe/eop (or $BRAHE_CACHE/eop if environment variable is set).

The directory is created if it doesn't exist.

Returns:

Raises:

1
2
3
4

import brahe as bh

eop_cache = bh.get_eop_cache_dir()
print(f"EOP cache: {eop_cache}")

Get the CelesTrak cache directory path.

Returns the path to the CelesTrak cache subdirectory used for storing downloaded TLE data. Defaults to ~/.cache/brahe/celestrak (or $BRAHE_CACHE/celestrak if environment variable is set).

The directory is created if it doesn't exist.

Returns:

Raises:

1
2
3
4

import brahe as bh

celestrak_cache = bh.get_celestrak_cache_dir()
print(f"CelesTrak cache: {celestrak_cache}")