PTB-MR / mrpro

MR image reconstruction and processing.
https://ptb-mr.github.io/mrpro/
Apache License 2.0
18 stars 2 forks source link

Split examples into scripts & notebooks subfolders #546

Open schuenke opened 2 days ago

schuenke commented 2 days ago

The number of example scripts/notebooks increased quite a lot already and will probably increase further in the future. FI was wondering if it might be a clearer structure if we split the examples folder into a scripts and a notebooks subfolder. Furthermore, it happened to me several times that I clicked on a notebook when I wanted to open a script and vise versa.

The new structure could look like this:

├── ...
├── examples
│   ├── notebooks
│   │   └── *.ipynb files
│   ├── scripts
│   │   └── *.py files
│   └── ruff.toml
└── ...

Or we could leave the scripts in the examples folder and only move the *.ipynb files into a notebooks subfolder:

├── ...
├── examples
│   ├── notebooks
│   │   └── *.ipynb files
│   ├── *.py files
│   └── ruff.toml
└── ...

Any opinions?

fzimmermann89 commented 2 days ago

+1 to splitting, I think I would slightly prefer option 1

schuenke commented 2 days ago

+1 to splitting, I think I would slightly prefer option .

Maybe it's just me, but I don't really understand which option you prefer 😨

fzimmermann89 commented 2 days ago

Not sure how that happened.😅

Separate notebooks and scripts folder in examples.

lrlunin commented 2 days ago

Should I do it in https://github.com/PTB-MR/mrpro/pull/537 then?

UPD: done in 865347a