data.download_encoding_volume

data.download_encoding_volume(
    local_path,
    label='2026_W42',
    project=None,
    res_um=None,
    one=None,
    overwrite=False,
)

Download a pre-computed ephys atlas encoding volume from AWS S3.

The encoding volume is a 4-D volumetric representation of electrophysiological features on the Allen Common Coordinate Framework (CCF), stored as a .npz file. Load the result with np.load(file_path, allow_pickle=True).

Parameters

Name	Type	Description	Default
local_path	Path	Local directory where the file will be saved.	required
label	str	Vintage label, e.g. “2026_W42”. Defaults to “2026_W42”.	'2026_W42'
project	str	Project name. Defaults to “ea_active”.	None
res_um	int	CCF voxel resolution in µm of the requested volume, e.g. 25 or 50. If not specified, automatically picks the finest (smallest) resolution available on S3 for this project/label.	None
one	ONE	ONE client instance for AWS authentication.	None
overwrite	bool	Force re-download even if the file already exists. Defaults to False.	False

Returns

Name	Type	Description
	Path	Local path to the downloaded .npz file.