Sandbox for Git-for-Science Workshop.
Read and Edit online: https://www.overleaf.com/15422340tzpscybmktkc
Read only: https://www.overleaf.com/read/zncknkybdkxg
Git clone to work offline:
$ git clone https://git.overleaf.com/15422340tzpscybmktkc
Create a Git repo on GitHub and clone it:
# Please create your own ... just showing the example with my sandbox
$ git clone git@github.com:cehbrecht/gitforscience-sandbox.git
$ cd gitforscience-sandbox
OR
Create you own local Git repo:
$ mkdir gitforscience-sandbox
$ cd gitforscience-sandbox
$ git init
Add the overleaf git repo as remote:
$ git remote add overleaf https://git.overleaf.com/15422340tzpscybmktkc
$ git remote -v
Make your repo identical to the overleaf repo. Be careful with this ... you will loose everything on your local master branch:
$ git reset --hard overleaf/master
# push it to your remote origin master ... if you have a remote
$ git push --force
Edit your Overleaf document locally:
$ atom main.tex # choose your favorite LaTeX editor
Commit your changes:
$ git status
$ git commit -a -m "update"
$ git push # push to remote origin master if you have one
Push your changes to Overleaf:
$ git pull overleaf master
$ git push overleaf master
First edit Overleaf document and the local document at different sections. Update your changes with the remote overleaf document. Changes will be merged automatically.
Now make edits at the same text line locally and in overleaf. Update your changes again but this time you will need to solve a merge conflict.
With git you can tag a version:
$ git tag 0.1
$ git push --tags # push all tags to your remote
Use this tag to create a release on GitHub: https://help.github.com/articles/creating-releases/
Using an online service you can create automatically a DOI for your paper on GitHub whenever you make a new release:
https://guides.github.com/activities/citable-code/
Version controls are made for coding and can handle text files very well. They can be used for binary files as well but this has some limitations. You can use Git LFS extension on GitHub to get around these limitations. Large binary files will then be stored in an external storage and not in the Git repo itself. The Git repo has only pointers to these files.
Not a good choice ... but possible:
- use Git LFS extension to handle binary files.
- use pandoc: http://blog.martinfenner.org/2014/08/25/using-microsoft-word-with-git/
Resolve merge conflict with docx:
- https://stackoverflow.com/questions/278081/resolving-a-git-conflict-with-binary-files
git mergetool- merge with Word: https://support.office.com/en-us/article/Combine-documents-f8f07f09-4461-4376-b041-89ad67412cfe
- close merge editor
Overleaf:
- https://www.overleaf.com/
- Online collaborative LaTeX editor with integrated real-time preview.
- Uses Git in the background.
- Alternatives
- ShareLatex: https://www.sharelatex.com/
- Authorea (LaTeX and Markdown): https://www.authorea.com/
GitHub:
- https://github.com/
- Online service for Git repositories and collaborative developing.
Git:
- https://git-scm.com/
- Version control system for decentralised software development.
LaTeX:
- https://www.tug.org/texlive/
- TexLive on macOS: https://www.tug.org/mactex/
- On macOS install it with homebrew: http://yabas.net/blog/install-latex-on-mac-with-brew/
- Write beautiful documents.
Editors:
- Atom: https://atom.io/
Doc Converters:
- Pandoc: https://pandoc.org/
Good Alternatives to LaTeX:
- Markdown: https://daringfireball.net/projects/markdown/
- Authorea: https://www.authorea.com/
- Restructred Text: http://docutils.sourceforge.net/rst.html
- Sphinx: http://www.sphinx-doc.org/en/master/
- ReadTheDocs: https://readthedocs.org/
Using Overleaf with Jupyter Notebooks: https://medium.com/thoughts-philosophy-writing/how-to-update-overleaf-from-a-juypter-notebook-5469b1405fdc