search

judithabk6 / med_bench

BSD 3-Clause "New" or "Revised" License
8 stars 3 forks source link

Get rid of the src folder #83

Closed brash6 closed 2 months ago

brash6 commented 2 months ago

Today the repository is organised this way : 

├── .github
│    ├── workflows
│    │    ├── main.yaml
├── .gitignore
├── LICENSE
├── README.md
├── notebooks
│    ├── noisymoons.pdf
│    ├── toy_example.ipynb
│    ├── results
│    │    ├── simulations
│    │    │    ├── 20211016_simulations.csv
│    │    │    ├── 20211110_simulations.csv
│    │    │    ├── 20211123_simulations.csv
│    │    │    ├── 20220118_simulations_isotonic.csv
├── setup.py
├── src
│    ├── med_bench
│    │    ├── get_estimation.py
│    │    ├── get_simulated_data.py
│    │    ├── mediation.py
│    │    ├── utils
│    │    │    ├── nuisances.py
│    │    │    ├── utils.py
│    │    │    ├── tests
│    │    │    │    ├── estimation
│    │    │    ├── test_get_estimation.py
│    │    │    ├── simulate_data
│    │    │    │    ├── test_get_simulated_data.py

I think it would be better to get rid of the src folder and have instead directly the med_bench folder as it's the best practice usually. Additionally, then the tests folder should be as the same level as the med_bench folder

What do you think @judithabk6 @houssamzenati @bthirion ?

bthirion commented 2 months ago

Hi, I thought that src layout was considered as better (in the sense of safer): https://packaging.python.org/en/latest/discussions/src-layout-vs-flat-layout/

brash6 commented 2 months ago

I didn't know it was, thank you for the link, really interesting !