scilaunch
A tiny program for you that lays the foundation for great discoveries.
Description
scilaunch helps you to set up your research project:
-
it creates a canonical directory structure tailored for research projects
🚀 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 -
scilaunchprepares your research code asPythonpackage ready forimport -
scilaunchoffers to set up acondaenvironment, and prepares it asjupyterkernel -
and
scilaunchcan init yourgitrepository
The project structure can be populated with other programming languages (R, matlab, etc.) as well.
Check out the scilaunch documentation 🚀 for more information.
Getting started
Install scilaunch
Ideally install scilaunch into your global/base Python environment, which should be python>=3.8.
Install from PyPI:
pip install -U scilaunch
Alternatively, install from the GitHub repo:
pip install -U git+https://github.com/SHEscher/scilaunch.git
It is also recommended to have conda installed.
🚀 Run scilaunch
Simply run scilaunch via the command line:
# Assuming you are in the parent directory that should host your research project
scilaunch
or provide the parent directory of your project by running:
scilaunch PATH/TO/PARENT/DIR
Then, you will be asked to provide some information relevant to your project.
When running scilaunch the first time, you will set some default values, which will ease your life for upcoming launches of research projects.
You can still change these default values in ~/.cookiecutterrc at a later stage.
Cookiecutter templates
scilaunch is a wrapper around the great cookiecutter package
and is mainly built around this template: research-project.
For how to build your own template(s) and to contribute to this project, please check out: CONTRIBUTING.md.
Note, after running scilaunch the first time, you can adapt your default values in ~/.cookiecutterrc at any time.
Check out the cookiecutter documentation for more information on the ~/.cookiecutterrc.
Metadata
Release files for scilaunch 0.3.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| scilaunch-0.3.1.tar.gz | 12.9 kB | Without provenance | Details for scilaunch-0.3.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| scilaunch-0.3.1-py3-none-any.whl | Python 3 | none | any | Details for scilaunch-0.3.1-py3-none-any.whl |
Total release size: 23.7 kB
Release files / scilaunch-0.3.1.tar.gz
| Download URL | scilaunch-0.3.1.tar.gz |
|---|---|
| Size | 12.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0788e75862ee9da4ac28655deaaf9c9cc3610f837e55b6593a8ba152a3a2fb1b
|
|
BLAKE2b-256 checksum How to use checksums |
2648ba06b2031e3f41adce40b46c7be58cb6137ccefe491e40cf1cb30339d5a9
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.6
|
Release files / scilaunch-0.3.1-py3-none-any.whl
| Download URL | scilaunch-0.3.1-py3-none-any.whl |
|---|---|
| Size | 10.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
9fdf5f20ff4c1c932ff207f4c33a072e6a74f8c8b45472392b6c6cd0b0b58911
|
|
BLAKE2b-256 checksum How to use checksums |
aa7458d3cc34d1b95a4d85f631941ec3c76dc12bd9e48a0df9e636223372ca4a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.6
|
Security for scilaunch 0.3.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.