Skip to content

Cookbook for Working with Git and VIC

jhamman edited this page Mar 9, 2013 · 6 revisions

Introduction

Git is a version control tool that we use to...

  • track changes over time in the VIC source code,
  • facilitate parallel development between multiple model developers and research projects,
  • encourage peer code review and bug tracking, and
  • to distribute official and bleeding edge releases of the model source code.

VIC for Model users (not developers)

In general, if you are only going to be using the model and not working directly on the source code, you may just download the model either from out website (insert html here), from our code page (link here). Additionally archived tags and releases may be found (here).

VIC for Developers

If you plan on contributing to model development or would like a systematic way to incorporate updates to the VIC source code, we encourage you to use Git. The following sections are designed to get you started using git and working with the VIC source code repository.

Git Resources

If you are not familiar with Git yet, we encourage you to spend a few minutes getting antiquated with the system before you starting working with the VIC source code and Git. It's not difficult to use and a few minutes of learning about Git will go along way in helping you manage your code development.

There are a number of good Git learning resources that will provide a basic introduction to the version control system.

  1. http://git-scm.com/about
  2. https://help.github.com/

Getting the code

Clone this wiki locally