BiAPoL / Quantitative_Bio_Image_Analysis_with_Python_2022

This repository hosts notebooks, information and data for the Quantitative Bio-Image Analysis with Python Course 2022.
https://BiAPoL.github.io/Quantitative_Bio_Image_Analysis_with_Python_2022
Creative Commons Attribution 4.0 International
15 stars 3 forks source link

Subsections? #2

Closed jo-mueller closed 1 year ago

jo-mueller commented 1 year ago

Maybe it would make sense to introduce subsections in the toc?

I think we would then have to write the TOC as follows:

parts:
  - caption: Name of Part 1
    chapters:
    - file: path/to/part1/chapter1
    - file: path/to/part1/chapter2
      sections:
      - file: path/to/part1/chapter2/section1
  - caption: Name of Part 2
    chapters:
    - file: path/to/part2/chapter1
    - file: path/to/part2/chapter2
      sections:
      - file: path/to/part2/chapter2/section1

It may help the structure if we have, say, 3 notebooks about thresholding, to have them in a separate sub-section of their own - what do you think @zoccoler @haesleinhuepf @thawn ?

jo-mueller commented 1 year ago

Update: You can simply do it like this:

- file: day3/Readme
  sections:
  - file: day3/01_Tidy_data
  - file: day3/02_Descriptive_statistics
  - file: day3/03_Correlation
  - file: day3/04_Data_exploration
  - file: day3/05_Dimentionality_reduction/Readme
    sections:
    - file: day3/01_UMAP
    - file: day3/02_UMAP
    - file: day3/03_PCA
zoccoler commented 1 year ago

Sure! First version was just an initial template, let's re-factor it. I am going to make it similar in structure to other teaching materials we have.

haesleinhuepf commented 1 year ago

The TOC structure appears ok to me. However, I think we should use a different folder structure. I started implementing it a bit differently: The folder structure is now something similar to our lecture. Sessions should have one folder on /docs/ level:

data/
docs/day1a_Python/notebook.ipnyb
docs/day1b_Image_analysis/notebook.ipnyb
docs/day2a_image_processing/notebook.ipnyb

Reason: We typically open data in notebooks using imread('../../data/blobs'). If we have a varying depth of folders from course to course, we have to adapt notebooks all the time.

haesleinhuepf commented 1 year ago

Thanks all for implementing this!