How to branch off your own version of a Maneage template

Make some changes and commit them locally

• Start with your directory set up of a research paper that already works, such as gevcurvest .
  1. Do ./project make to check that the pdf is still produced correctly.
  2. Make some changes. To start with, you can make some trivial edits. Once you're ready for more serious edits, scroll down.
  3. Test them and store a log file, just in case: ./project make |& tee log.2 if you want your log file to be called log.2
  4. If there's a failure:
     • investigate the log file, try to understand what went wrong. You have full control of all the plain text files of the full pipeline, so read and search through them using less, grep, and other related tools. If you're unfamiliar with less and grep, then try info less and info grep. Even if you're familiar with grep, you can probably learn some more, so try info grep anyway.
     • Try to tr * Start with your directory set up of a research paper that already works, such as gevcurvest .
  5. Do ./project make to check that the pdf is still produced correctly.
  6. Make some changes.
  7. Test them and store a log file, just in case: ./project make |& tee log.2 if you want your log file to be called log.2
  8. If there's a failure:
     • investigate the log file, try to understand what went wrong. You have full control of all the plain text files of the full pipeline, so read and search through them using less, grep, and other related tools. If you're unfamiliar with less and grep, then try info less and info grep. Even if you're familiar with grep, you can probably learn some more, so try info grep anyway.
     • Try to trace the bug yourself, but also ask on irc/matrix, email, by reading the README* files, and by looking at Maneage Support, Bug and Task trackers.
     • Also ask the lecturer for help ;).
  9. If there's no failure, or after fixing the bug:
     • Start or improve your knowledge of git with: man gittutorial
     • Create your own branch in a logical sense e.g. git branch mybranch
     • Change your logical location (in the git sense) to your own branch: git checkout mybranch
       • Use commands such as git log --stat or git log --all --graph --oneline to check the git evolution.
     • Commit any modified files with e.g. git commit -a
       • If you don't like the default editor, then set your git config editor, e.g. with git config --get core.editor to check your current editor, and git config --set core.editor 'emacs -nw' if you want your editor to be emacs -nw
     • Use commands such as git log --stat or git log --all --graph --oneline to check the git evolution. You should see that your commit is in the mathematical graph of the evolution of the set of files.ace the bug yourself, but also ask on irc/matrix, email, by reading the README* files, and by looking at Maneage Support, Bug and Task trackers.
     • Also ask the lecturer for help ;).
  10. If there's no failure, or after fixing the bug:
      • Start or improve your knowledge of git with: man gittutorial
      • Create your own branch in a logical sense e.g. git branch mybranch
      • Change your logical location (in the git sense) to your own branch: git checkout mybranch
        • Use commands such as git log --stat or git log --all --graph --oneline to check the git evolution.
      • Commit any modified files with e.g. git commit -a
        • If you don't like the default editor, then set your git config editor, e.g. with git config --get core.editor to check your current editor, and git config --set core.editor 'emacs -nw' if you want your editor to be emacs -nw
      • Use commands such as git log --stat or git log --all --graph --oneline to check the git evolution. You should see that your commit is in the mathematical graph of the evolution of the set of files.

What changes should you make?

• Remove the current workflow - the science steps of the sequence - except for the beginning and end:
  • To do this, edit the makesrc definition of reproduce/analysis/make/top-make.mk (This is what is currently written as Add `XXXXXX`, as a new line, to the values in `makesrc` of the top-level `Makefile`. in README-hacking.md .)
  • Remove the strings init-N-body , run-simulations and analyse-plot from the definition of makesrc
• Disable verification of the results of the project, because we're making a fresh project:
  • Edit the reproduce/analysis/conf/verify-outputs.conf - remove "yes"
• Now you should be able to do ./project make |& tee log.3 . * There will probably be some errors, since some of the workflow rules are now unknown to top-make.mk .
• TODO: What cleanup is needed at this step for gevcurvtest commit d18ce51?
• Edit paper.tex removing most of the main content that is not yours. Leave in some content as temporary examples, and put some markers such as \textbf{NOTMYSTUFF} on content that you leave in place so that you don't accidentally leave it in place in your own paper.
  • Try ./project make and do fixes until you again can produce a very minimal template pdf.