create_readme#

brainglobe_atlasapi.atlas_generation.metadata_utils.create_readme(uncompr_atlas_path, metadata_dict, structures)[source]#

Create a README.txt file for the atlas in the specified path.

This function generates a comprehensive README file containing atlas metadata and structure information for a BrainGlobe atlas.

Parameters:

  • uncompr_atlas_path (pathlib.Path) – The path to the uncompressed atlas directory where the README will be saved.

  • metadata_dict (dict) – A dictionary containing the atlas’s metadata (e.g., name, citation, species).

  • structures (list of dict) – A list of dictionaries, where each dictionary represents a structure with its ID, name, and other relevant properties.

On this page