Git

It is a good idea to use a version-control system (VCS) to keep track of the code that runs your experiment. This allows you to have a record of the software used to acquire data on a specific day of experiments. It also protects against accidental and untraceable changes to code on your microscope that could affect how data is acquired. The current recommended VCS for ScopeFoundry projects is Git.

Install git

Windows

• for example using conda install git, or using the SourceTree software and configure it.

• for new commers I recommend this youtube tutorial

Remember to configure your git user info:

git config --global user.name "Nobody Nobinov"
git config --global user.email "nnobinov@example.com"

Start your main repo

Lets create a git repository to store the code for the microscope app

# cd "to/your_project_folder"
git init

We add files using:

git add fancy_app.py

And commit changes to perminanet history using

git commit -m "cool changes happen here"

Sync with GitHub

It is recommended to sync changes to a free repository on GitHub.

After making a New repository on GitHub named {USER_NAME}/{fancy_app}, you will have url of the form: https://github.com/{USER_NAME}/{fancy_app}.git

To link your local repository to the one on github

git add remote origin https://github.com/{USER_NAME}/{fancy_app}

There are are many tutorials on web that address how to use git effectively, so we will not repeat that here.

There are also good graphical interfaces to Git that you may want to check out. One recommendation SourceTree that has a great tutorial.