Skip to content

refactor: Update documentation to new path, renamed package to tfe_data - #112

Merged
ShrimpCryptid merged 9 commits into
mainfrom
refactor/update-docs
Sep 16, 2026
Merged

ShrimpCryptid merged 9 commits into
mainfrom
refactor/update-docs

Conversation

@ShrimpCryptid

@ShrimpCryptid ShrimpCryptid commented Sep 14, 2026 •

Copy link
Copy Markdown
Contributor

Problem

This repo has been moved from allen-cell-animated/colorizer-data to AllenCell/tfe-data. I've updated links to refer to the new path across our documentation and tutorials.

Additionally, I also renamed the main module from colorizer_data to tfe_data, and updated imports across the code and documentation to refer to the new paths.

In a follow-up PR, I'll also be renaming a few methods, with deprecation warnings for the old methods. Together, these will both make a new major release bump of this repo.

Estimated review size: small, 5-10 minutes

Solution

  • Renamed colorizer_data package to tfe_data.
    • Updated imports to reflect the new package location.
  • Updated links to allen-cell-animated/colorizer-data to point to AllenCell/tfe-data.

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Steps to Verify:

  1. Tests ran and passed!

@ShrimpCryptid ShrimpCryptid self-assigned this Sep 14, 2026
@ShrimpCryptid ShrimpCryptid added documentation Improvements or additions to documentation internals labels Sep 14, 2026
@ShrimpCryptid ShrimpCryptid changed the title refactor: Update documentation to refer to new repo, renamed package to tfe_data refactor: Update documentation to new path, renamed package to tfe_data Sep 14, 2026
convert_colorizer_data,
FeatureInfo,
FeatureType,
ColorizerMetadata,

@ShrimpCryptid ShrimpCryptid Sep 14, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will get renamed to DatasetMetadata soon and the old data class will be removed.

@ShrimpCryptid
ShrimpCryptid added this pull request to stack #114 September 14, 2026 18:58

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Installation instructions target an incompatible old tag, and several renamed paths remain incorrect.

Get a fresh assessment by requesting another Copilot review.

Pull request overview

Renames the Python package to tfe_data, updates repository references, and relocates the bundled TFE viewer.

Changes:

  • Migrates package imports and packaging metadata.
  • Updates documentation, examples, and tests.
  • Includes viewer runtime assets under the renamed package.
File summaries
File Description
tfe_data/writer.py Updates imports and documentation links.
tfe_data/utils.py Updates imports and documentation link.
tfe_data/types.py Relocates package type definitions.
tfe_data/converter.py Updates package imports and examples.
tfe_data/bin/viewer/default/index.html Adds bundled viewer entry page.
tfe_data/bin/viewer/default/images/aics-logo.svg Adds viewer logo.
tfe_data/bin/viewer/default/assets/webimage-DBgUwIbt.js Adds image decoder bundle.
tfe_data/bin/viewer/default/assets/raw-in9isEBO.js Adds raw decoder bundle.
tfe_data/bin/viewer/default/assets/pako.esm-BkaqWuDM.js Adds compression bundle.
tfe_data/bin/viewer/default/assets/packbits-DDWKfGV_.js Adds PackBits decoder.
tfe_data/bin/viewer/default/assets/main-EL5x51Au.css Adds viewer styles.
tfe_data/bin/viewer/default/assets/lzw-_aCqfs4w.js Adds LZW decoder.
tfe_data/bin/viewer/default/assets/lz4-BIGKWw27.js Adds LZ4 decoder.
tfe_data/bin/viewer/default/assets/jpeg-JhJy4lL1.js Adds JPEG decoder.
tfe_data/bin/viewer/default/assets/gh_routing-Ccc8RuuD.js Adds static-host routing.
tfe_data/bin/viewer/default/assets/FetchTiffWorker-CfWXhx_B.js Adds TIFF worker bundle.
tfe_data/bin/viewer/default/assets/deflate-Dthki0TA.js Adds Deflate decoder.
tfe_data/bin/viewer/default/assets/chunk-INHXZS53-D3tQiqtZ.js Adds shared bundle code.
tfe_data/bin/viewer/default/assets/basedecoder-B2c5_Eok.js Adds base decoder.
tfe_data/bin/viewer/default/assets/BannerVideo-W0lKlmpc.js Adds banner component bundle.
tfe_data/bin/viewer/default/assets/404-CzBSvGm8.js Adds redirect bundle.
tfe_data/bin/viewer/default/404.html Adds viewer fallback page.
tfe_data/bin/tfe_open.py Relocates the local viewer CLI.
tfe_data/__init__.py Exposes the renamed package API.
tests/test_writer.py Updates writer imports.
tests/test_utils.py Updates utility imports.
tests/test_types.py Updates type imports.
tests/test_converter.py Updates converter imports and fixture path.
README.md Updates package and installation instructions.
pyproject.toml Renames distribution, package, URLs, and entry points.
documentation/getting_started_guide/requirements.txt Renames the tutorial dependency.
documentation/getting_started_guide/GETTING_STARTED.ipynb Updates tutorial paths and imports.
documentation/DATA_FORMAT.md Updates package and repository references.
documentation/bin/example_scripts/getting_started_guide.py Updates example imports and CLI path.
documentation/bin/example_scripts/check_conversion_api.py Updates example import.
.gitignore Updates the ignored viewer path.
.bumpversion.toml Updates the versioned package path.
Review details

Suppressed comments (1)

documentation/getting_started_guide/GETTING_STARTED.ipynb:580

  • The repository was updated, but the source path in this link still uses the removed colorizer_data directory. The link therefore returns 404 instead of opening the converter documentation.
        "[`convert_colorizer_data`](https://github.com/AllenCell/tfe-data/blob/main/colorizer_data/converter.py#L390) includes detailed documentation for additional configuration options and parameters.\n",
  • Files reviewed: 13/51 changed files
  • Comments generated: 5
  • Review effort level: Balanced

💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread tests/test_converter.py Outdated
Comment thread README.md
Comment thread documentation/DATA_FORMAT.md Outdated
Comment thread documentation/getting_started_guide/GETTING_STARTED.ipynb Outdated
Comment thread documentation/getting_started_guide/requirements.txt
@ShrimpCryptid
ShrimpCryptid marked this pull request as ready for review September 14, 2026 20:59
@ShrimpCryptid ShrimpCryptid linked an issue Sep 15, 2026 that may be closed by this pull request
@ShrimpCryptid
ShrimpCryptid merged commit 6918729 into main Sep 16, 2026
1 check passed
@ShrimpCryptid
ShrimpCryptid deleted the refactor/update-docs branch September 16, 2026 18:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation internals

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update links + documentation with new tfe-data name

4 participants