A tiny program for you, seting up the ground for grant discoveries. (2023)
Project description
scilaunch
A tiny program for you that lays the foundation for great discoveries.
[Last update 2023-10-05 | v.0.1.0]
Description
scilaunch
helps you to set up your research project:
-
create a canonical directory structure tailored for research projects
-
for python users it offers to set up a
conda
environment -
it prepares your research code as
python
package ready forimport
-
and
scilaunch
can init yourgit
repository
The project structure can be populated with other programming languages (R
, matlab
, etc.) as well.
scilaunch
is a wrapper around the great cookiecutter
package and is mainly build around this template: research-project.
Getting started
Install scilaunch
Ideally install scilaunch
into your global/base python
environment, which should be python>=3.8
.
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:
scilaunch PARENT/DIR/OF/YOUR/RESEARCH/PROJECT
# OR cd into the parent dir and just run `scilaunch`
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
You can also fork / adopt the underlying research-project
template for scilaunch
from here: https://github.com/SHEscher/research-project. This template works also directly with cookiecutter
.
To build your own templates, check out the cookiecutter
docs.
Here you can find also more information on the ~/.cookiecutterrc
TODO's
- allow to pass other
cookiecutter
templates - add proper docs
- add files in
/.github/ISSUE_TEMPLATE/
- add
CONTRIBUTING.md
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for scilaunch-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6462f56d9b7225eabc7fe15e79c820d864991eb9e4c0f0e8054efe3bc5b1b9a9 |
|
MD5 | e77000f4735b07c366aeffdaeb7683c1 |
|
BLAKE2b-256 | ed7fa22b033761c219b329d79e4832d91d61f0cc51c5213751f5d4e0d0ebef3f |