Skip to content

Initial directory setup for an academic research project. Makes it easier to share code, track project, and collaborate on writing.

License

Notifications You must be signed in to change notification settings

suhasvijayakumar/academic_project_template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Project

Project template folder

Data created:

Last updated:

Project description

Initial directory setup for an academic research project. Makes it easier to share code, track project, and collaborate on writing.

People

Creator - full_name, @username

Supervisors - full_name, @username | full_name, @username

Collaborators - full_name, @username | full_name, @username

Institute

Institute name, country

Directory structure

.
├── README.md
├── code
├── data
├── docs
│   ├── article
│   ├── notes
│   │   └── article_summaries.md
│   └── presentation
├── logs
│   └── meeting_notes.md
├── results
│   └── figures
└── scratch

>> Treat scratch as a temporary folder to dump all intermediate files, before you move final versions to results.

Links

Getting started

Tooling up for Plain Text Academic Writing in Markdown, by Eric J. Ma | blogpost

PhD Starter Kit, by Achintya Rao | website

Important literature and websites

Git can facilitate greater reproducibility and increased transparency in science, Ram, K. (2013) | article

Reproducible Research Project Initialization | github

Project template, by John Myles White | github | website

Current status

  • Setup project directory
  • Initialise git
  • Get cracking

About

Initial directory setup for an academic research project. Makes it easier to share code, track project, and collaborate on writing.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published