Description

With one command https://github.com/SHEscher/scilaunch creates the folder structure for your new research project on your machine. Moreover, it prepares Python files such that you can use your research code as your own Python package, with the first line of code. It prepares a conda environment for you and initializes agit repository.

Install

pip install -U scilaunch

Run

scilaunch PARENT/DIR/OF/YOUR/PROJECT

You get

> tree PATH/TO/YourGreatStudy

🚀 YourGreatStudy/
├── 📄 README.md
├── 📂 code
│   ├── 📁 Rscripts
│   ├── 📁 configs
│   ├── 📂 notebooks
│   │   └── 🐍 yourgreatstudy.ipynb
│   ├── 📁 tests
│   └── 📂 yourgreatstudy
│       ├── 🐍 __init__.py
│       └── 📁 preprocessing
├── 📂 data
│   ├── 📋 participants.tsv
│   ├── 📁 sub-01
│   ├── 📁 sub-02
│   └── 📁 sub-03
├── 📂 literature
│   ├── 📁 pdfs
│   └── 📙 yourgreatstudy.bib
├── 📂 organisation
│   ├── 📁 ethics
│   ├── 📁 participation_forms
│   ├── 📁 preregistration
├── 📂 publications
│   ├── 📁 articles
│   ├── 📁 poster
│   └── 📁 presentations
├── 📄 pyproject.toml
├── 📂 results
│   └── 📁 datavisualization
└── 🐍 setup.py

<aside> 💡 Note that all files & folders can be changed or deleted. Files & folders, e.g., in ./data/ are used as examples. However, adapt only, where you understand the effect to the rest of the structure. For instance, pyproject.toml is needed for the install of the project package. Files in ./code/configs/are relevant for proper path and parameter settings in your Python scripts, and so on.

</aside>

More details

Overview - scilaunch

Who can help

Untitled