Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
C
cookiecutter-data-analysis
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Deploy
Releases
Model registry
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
SASC
cookiecutter-data-analysis
Commits
0195f731
Commit
0195f731
authored
9 years ago
by
Jeroen F.J. Laros
Browse files
Options
Downloads
Patches
Plain Diff
Added documentation.
parent
44fdc324
No related branches found
No related tags found
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
README.md
+78
-0
78 additions, 0 deletions
README.md
with
78 additions
and
0 deletions
README.md
0 → 100644
+
78
−
0
View file @
0195f731
# Project skeleton
A skeleton Git repository for analysis projects.
# Preparations
Install dependencies.
```
bash
pip
install
cookiecutter
pip
install
python-gitlab
```
Configure Cookiecutter by editing
`.cookiecutterrc`
in your home directory.
```yml
---
default_context:
full_name: Your Name
email: UserName@lumc.nl
cookiecutters_dir: /path/to/cookiecutters/
```
Configure Python GitLab by editing `.python-gitlab.cfg` in your home directory.
```
INI
[global]
default = gitlab
ssl_verify = true
timeout = 5
[gitlab]
url = https://git.lumc.nl
private_token = your_token_here
```
# Starting a project
To start a new analysis project based on this skeleton, follow the following
steps:
```
bash
cookiecutter https://git.lumc.nl/sasc/cookiecutter-data-analysis.git
```
## Working together on the same clone
If you need to work with other people on the same repository clone on the Shark cluster, you can use the following command to give group access:
```
bash
find -type d -exec chmod 775 {}
\;
find -type f -exec chmod 664 {}
\;
```
## Cloning to a portable disk (NTFS)
Presuming your disk is attached to your own computer and the repository is on
the Shark cluster, you can use the following commands.
git clone ssh://shark/path/to/project/my-project
cd my-project
For some reason `annex-ignore` is set to `true`, we need to set it to `false`.
git config remote.origin.annex-ignore false
Set the repository to *direct mode* to prevent making symlinks, otherwise it
will be very difficult for windows users to access the files.
git annex direct
SSH caching seems to be broken on NTFS.
git config annex.ssh-options "-S /tmp/ssh_mux_%h_%p_%r"
Or alternatively, disable SSH caching all together (slow when working with a
large number of files).
git config annex.sshcaching false
Get the content.
git annex get .
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment