| Name | scilaunch JSON |
| Version |
0.2.2
JSON |
| download |
| home_page | None |
| Summary | A tiny program for you, setting up the ground for grand discoveries. (2023) |
| upload_time | 2024-03-23 11:30:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD License Copyright (c) 2023, Simon M. Hofmann All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
template
bids
reproducibilty
standardization
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# scilaunch
A tiny program for you that lays the foundation for great discoveries.
[](https://github.com/shescher/scilaunch/blob/master/LICENSE)
[](https://shescher.github.io/scilaunch)
[](https://github.com/shescher/scilaunch/tags)
## Description
`scilaunch` helps you to set up your research project:
1. 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
```
2. `scilaunch` prepares your research code as `Python` package ready for `import`
3. `scilaunch` offers to set up a `conda` environment, and prepares it as `jupyter` kernel
4. and `scilaunch` can init your `git` repository
---
The project structure can be populated with other programming languages (`R`, `matlab`, etc.) as well.
Check out the `scilaunch` [documentation](https://shescher.github.io/scilaunch) 🚀 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:
```shell
pip install -U scilaunch
```
Alternatively, install from the GitHub repo:
```shell
pip install -U git+https://github.com/SHEscher/scilaunch.git
```
It is also recommended to have [`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) installed.
### 🚀 Run `scilaunch`
Simply run `scilaunch` via the command line:
```shell
# Assuming you are in the parent directory that should host your research project
scilaunch
```
or provide the parent directory of your project by running:
```shell
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`](https://github.com/cookiecutter/cookiecutter) package
and is mainly built around this template: [`research-project`](https://github.com/SHEscher/research-project).
How to build your own template(s) and 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](https://cookiecutter.readthedocs.io/en/stable/index.html) for more information on the `~/.cookiecutterrc`.
Raw data
{
"_id": null,
"home_page": null,
"name": "scilaunch",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "\"Simon M. Hofmann\" <simon.hofmann@pm.me>",
"keywords": "template, BIDS, reproducibilty, standardization",
"author": null,
"author_email": "\"Simon M. Hofmann\" <simon.hofmann@pm.me>",
"download_url": "https://files.pythonhosted.org/packages/25/6f/d41069eeda34c5657ffae4899db9c2c13c2fdb865c39563f8f4125cf983e/scilaunch-0.2.2.tar.gz",
"platform": "unix",
"description": "# scilaunch\n\nA tiny program for you that lays the foundation for great discoveries.\n\n\n\n\n\n[](https://github.com/shescher/scilaunch/blob/master/LICENSE)\n[](https://shescher.github.io/scilaunch)\n[](https://github.com/shescher/scilaunch/tags)\n\n\n## Description\n\n`scilaunch` helps you to set up your research project:\n\n1. it creates a canonical directory structure tailored for research projects\n ```\n \ud83d\ude80 yourgreatstudy/\n \u251c\u2500\u2500 \ud83d\udcc4 README.md\n \u251c\u2500\u2500 \ud83d\udcc2 code\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 Rscripts\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 configs\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc2 notebooks\n \u2502\u00a0\u00a0 \u2502\u00a0\u00a0 \u2514\u2500\u2500 \ud83d\udc0d yourgreatstudy.ipynb\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 tests\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 \ud83d\udcc2 yourgreatstudy\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udc0d __init__.py\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 \ud83d\udcc1 preprocessing\n \u251c\u2500\u2500 \ud83d\udcc2 data\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udccb participants.tsv\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 sub-01\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 sub-02\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 \ud83d\udcc1 sub-03\n \u251c\u2500\u2500 \ud83d\udcc2 literature\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 pdfs\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 \ud83d\udcd9 yourgreatstudy.bib\n \u251c\u2500\u2500 \ud83d\udcc2 organisation\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 ethics\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 participation_forms\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 preregistration\n \u251c\u2500\u2500 \ud83d\udcc2 publications\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 articles\n \u2502\u00a0\u00a0 \u251c\u2500\u2500 \ud83d\udcc1 poster\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 \ud83d\udcc1 presentations\n \u251c\u2500\u2500 \ud83d\udcc4 pyproject.toml\n \u251c\u2500\u2500 \ud83d\udcc2 results\n \u2502\u00a0\u00a0 \u2514\u2500\u2500 \ud83d\udcc1 datavisualization\n \u2514\u2500\u2500 \ud83d\udc0d setup.py\n ```\n2. `scilaunch` prepares your research code as `Python` package ready for `import`\n\n3. `scilaunch` offers to set up a `conda` environment, and prepares it as `jupyter` kernel\n\n4. and `scilaunch` can init your `git` repository\n\n---\n\nThe project structure can be populated with other programming languages (`R`, `matlab`, etc.) as well.\n\nCheck out the `scilaunch` [documentation](https://shescher.github.io/scilaunch) \ud83d\ude80 for more information.\n\n## Getting started\n\n### Install `scilaunch`\n\nIdeally install `scilaunch` into your global/base `Python` environment, which should be `python>=3.8`.\n\nInstall from PyPI:\n```shell\npip install -U scilaunch\n```\n\nAlternatively, install from the GitHub repo:\n```shell\npip install -U git+https://github.com/SHEscher/scilaunch.git\n```\n\nIt is also recommended to have [`conda`](https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html) installed.\n\n### \ud83d\ude80 Run `scilaunch`\n\nSimply run `scilaunch` via the command line:\n\n```shell\n# Assuming you are in the parent directory that should host your research project\nscilaunch\n```\n\nor provide the parent directory of your project by running:\n\n```shell\nscilaunch PATH/TO/PARENT/DIR\n```\n\nThen, you will be asked to provide some information relevant to your project.\n\n\nWhen running `scilaunch` the first time, you will set some default values, which will ease your life for upcoming launches of research projects.\n\nYou can still change these default values in `~/.cookiecutterrc` at a later stage.\n\n---\n\n## Cookiecutter templates\n\n`scilaunch` is a wrapper around the great [`cookiecutter`](https://github.com/cookiecutter/cookiecutter) package\nand is mainly built around this template: [`research-project`](https://github.com/SHEscher/research-project).\n\nHow to build your own template(s) and contribute to this project: please check out `CONTRIBUTING.md`.\n\nNote, after running `scilaunch` the first time, you can adapt your default values in `~/.cookiecutterrc` at any time.\nCheck out the `cookiecutter` [documentation](https://cookiecutter.readthedocs.io/en/stable/index.html) for more information on the `~/.cookiecutterrc`.\n",
"bugtrack_url": null,
"license": "BSD License Copyright (c) 2023, Simon M. Hofmann All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "A tiny program for you, setting up the ground for grand discoveries. (2023)",
"version": "0.2.2",
"project_urls": {
"Cookiecutter-Template": "https://github.com/SHEscher/research-project",
"Documentation": "https://shescher.github.io/scilaunch/",
"GitHub": "https://github.com/SHEscher/scilaunch"
},
"split_keywords": [
"template",
" bids",
" reproducibilty",
" standardization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "91fdef445a604be5abd5bec3e2729d52f1ee4554b613cdc6e8b5e86021c467a9",
"md5": "dcc578561b8bf3703d39cc448ab86127",
"sha256": "aa32fb6e70b8f4f8204772b2a1da427df4a56d5ab731cde6e44eb34c1fa754f2"
},
"downloads": -1,
"filename": "scilaunch-0.2.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "dcc578561b8bf3703d39cc448ab86127",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10620,
"upload_time": "2024-03-23T11:30:24",
"upload_time_iso_8601": "2024-03-23T11:30:24.456060Z",
"url": "https://files.pythonhosted.org/packages/91/fd/ef445a604be5abd5bec3e2729d52f1ee4554b613cdc6e8b5e86021c467a9/scilaunch-0.2.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "256fd41069eeda34c5657ffae4899db9c2c13c2fdb865c39563f8f4125cf983e",
"md5": "c2a4c820049bca26cdbd6b607de813df",
"sha256": "5e887dbab3cbf869ea3ae2fcb7ce65decbe87cf2efa7c6d434e5070a4cad51e5"
},
"downloads": -1,
"filename": "scilaunch-0.2.2.tar.gz",
"has_sig": false,
"md5_digest": "c2a4c820049bca26cdbd6b607de813df",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 12675,
"upload_time": "2024-03-23T11:30:26",
"upload_time_iso_8601": "2024-03-23T11:30:26.500312Z",
"url": "https://files.pythonhosted.org/packages/25/6f/d41069eeda34c5657ffae4899db9c2c13c2fdb865c39563f8f4125cf983e/scilaunch-0.2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-23 11:30:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "SHEscher",
"github_project": "research-project",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "scilaunch"
}
