Open Science Toolkit

This toolkit tries to make open science, open (software) projects and open courses as easy and efficient as possible to do and share with others. It provides a collection of scripts, templates, docs, packages and configs for an open, innovative working process on your Linux or Mac pc. It supports the use of open source tools like zsh, Python, R, Libre Office and Git, open formats like csv, svg and png and additionally the open practice from Open Science Projekt.

Basic functions

Scripts: different file conversions (e.g. svg2pdf, odt2pdf,...)
Aliases: add gitignore, add LICENSE files
Configs: git and zsh
Templates: open source software & creative commons licenses, gitignores, coding files
Git: Hooks (with warning messages)
Easy installation

Open Science Projekt functions

These functions are adapted to an open workflow used for open science, open source software development and open publishing as part of science, courses and projects on the Open Science Projekt. They are not restricted to it, so I think they are quite helpful for any workflow (especially, when you adopt the toolkit to your individuel workflow and needs).

Configs: adapted zsh and git configs
Easy setup of science, project and course repositories
Templates: github markdown, website
Git: specific git-hooks

The toolkit works together with these

SOFTWARE AND PACKAGES

zsh: advanced shell
Git: sourcecode and other data versioning software
GitHub: webservice for Git
Libre Office: Open Source Office Suite
bookmarks2mediawiki by skasberger: html 2 mediawiki converter (in R)
zsh-lovers by grml: zsh config
licenses by okfn: information about open definition compatible licenses as json
templates by skasberger: code and open source software licenses
templates by openscienceASAP: markdown and github templates for openscienceASAP
gitignore by github: gitignore files for different software projects and programming languages

LICENSE

Our part of the software is licensed under the MIT License. All foreign packages or files (in the folder ext/) are licensed as stated from their side.

WEBPAGE

INSTALL

Prerequisites

To be able to use this toolkit, you first need to install this packages Please look at their documentation sites for this.

zsh: advanced shell
Git: sourcecode and other data versioning software
Libre Office: Open Source Office Suite The installation of zsh is mandatory. If other packages are missing, the related functions will not work (properly).

Install

# download archive
wget https://github.com/openscienceASAP/openscience-toolkit/archive/master.zip
unzip master.zip

# install
cd openscience-toolkit-master
sh install.sh

Download External Packages

sh fetch-ext.sh

Uninstall

All files created by install will be deleted, not the custom ones.

sh ~/openscience-toolkit/shell/uninstall.sh

DOCUMENTATION

Basic functions

Git-Hooks

Aliases

Templates

Configs

openscienceASAP Functions

Git-Hooks

Aliases

Templates

Configs

ToDo

saubere Versionsschritte: änderungen an neuen files, die in den openscience ordner installiert werden mitdokumentieren und bei uninstall wieder löschen => es sollen keine dateien gelöscht werden, die nicht vom repo installiert wurden, aber alle die davon kamen; auf das löschen im uninstall script hinweisen
check, where to create folder: pre create everything or at the point where the content will be filled?; how is it about overwriting existing files (good, bad?)
change tmp folder to .tmp
document neccessary pre-installed packages to work with the script: git, zsh,
the folder should work in custom folder locations
Error messages für jeden relevanten Schritt schreiben

skasberger / openscience-toolkit Goto Github PK