tiatoolbox icon indicating copy to clipboard operation
tiatoolbox copied to clipboard

Enhance download paths in the examples notebooks

Open GeorgeBatch opened this issue 1 year ago • 0 comments

  • TIA Toolbox version: 1.5.1
  • Python version: 3.11.8
  • Operating System: CentOS Linux 7 (Core)

Description

In the example notebooks, the files are sometimes downloaded into the examples directory instead of the examples/tmp/ directory. The examples/tmp/ is the place for downloads since it gets cleared at the start of every notebook.

What I Did

In examples/10-wsi-registration.ipynb I changed:

fixed_img_file_name = Path("fixed_image.tif")
moving_img_file_name = Path("moving_image.tif")

to

fixed_img_file_name = global_save_dir / "fixed_image.tif"
moving_img_file_name = global_save_dir / "moving_image.tif"

I wanted to make a pull request with fixes like that.

Problem: But because of the notebook format, the metadata changes when I save the notebook. Instead of a 2-line change, GitHub sees more than 100 deletions and additions. See: https://github.com/GeorgeBatch/tiatoolbox/commit/97d65b939934d5ece8091fbd72904ead080620e0

Possible solution: Maybe it's better to have the example notebooks saved without the outputs.

GeorgeBatch avatar Apr 26 '24 11:04 GeorgeBatch