Using Subversion and TortoiseSVN for Windows

byGalen WilkersonGund Institute for Ecological EconomicsUniversity of Vermont

galen.wilkerson@uvm.edu

Lesson Plan

• Go over installation of Subversion and Simile (windows/mac)

• On your own: Go through the Simile tutorialshttp://simulistics.com/tutorials/index.htm

• On your own: Go through our presentations on Subversion – TortoiseSVN (Windows) or svnX (Mac) – remainder of this presentation

• We will be available another time on Wimba and by email/phone to answer questions about the tutorials

• When collaborating, it is important to manage changes in the models. For example:– To create or edit a submodel

• E.g. Habitat suitability is replaced with another method of computing habitat values.

– To submit a “rough copy” of a model to the repository for review by collaborators at another institution.

– To keep track of data needed from other submodels.• Can submit a “data request” to all model developers

– To keep track of influences/data-flow between submodels.– To revise documentation.– To track revisions by author, time, date, revision number.– Possibly the best feature: Nothing is ever “gone

forever” , since you can always recover the last version.

Using Subversion

TortoiseSVN (Windows)Getting started

• How to download and install

• Adding a model you have created

• Modifying an existing file

TortoiseSVN (Windows)Getting started

How to download and install– Visit the download site of tortoiseSVNhttp://tortoisesvn.net/downloads– Click “32-bit installer”

Should look something like:“TortoiseSVN-1.4.3.8645-win32-svn-

1.4.3.msi”(Version numbers may be different.)

TortoiseSVN (Windows)Getting started

How to download and install– Double-click on the

downloaded installer file

– Step through the installation process

– Once you have installed TortoiseSVN, your Windows Explorer will be modifiied

• Whenever you right-click somewhere, you see additional menu-items

TortoiseSVN (Windows)Getting started

To obtain the Subversion repository location

From the MIMES repository homepage:

– Click “Code” menu• Click “SVN”• Within SVN, the following URL appears:

https://mimes.svn.sourceforge.net/svnroot/mimes

TortoiseSVN:Common Subversion tasks

- Add a new file to the repository

- Modify an existing file in the repository

(Note: For more information on this in the tortoiseSVN help:

- Right click anywhere- Choose TortoiseSVN->Help- Scroll to Chapter 5: Daily Use Guide)

TortoiseSVN:Add a new file to the repositoryOverview:

- Checkout appropriate folder from the repository (The folder where you will put your model.)

- Create file (model file or other – documentation, etc.)

- “Add”

- “Commit”

TortoiseSVN:Add a new file to the repository

(continued)

- Checkout appropriate folder from the repository

- Start the “Repo-browser”

(Repository browser)

TortoiseSVN:Add a new file to the repository

(continued)

- Choose the folder where your new model belongs(Here, have chosen Aesthetic/)

- Right-click on the folder and choose “Checkout…”

- A “Checkout” window appears

TortoiseSVN:Add a new file to the repository

(continued)- Click the “…” next to “Checkout

Directory”

- A “Browse for Folder” window appears

- Browse to the folder on your computer where you want to create a local copy of the repository folder

- Create a folder with the same name as the one in the repository

- Click “Make New Folder”- Enter the new folder name

(Here “Aesthetic”)

- Click “OK”

TortoiseSVN: Add a new file to the repository (continued)

- This window appears telling you what has been downloaded:

- The folder you created now looks like this:

- It contains the files from the repository

TortoiseSVN: Add a new file to the repository (continued)

- Move, copy, or create a new file that will be added to the repository

- Give the file a descriptive name to distinguish it from other files

(Remember, we are adding a new file.)

TortoiseSVN: Add a new file to the

repository(continued)

- Use “Add” to add it to the local repository

- Right-click the new file(Here, right-click on “Aesthetic”)- Click “TortoiseSVN->Add”- A window appears- Click “OK”

- A blue “plus” symbol should appear on the file in Windows Explorer:

TortoiseSVN: Add a new file to the repository (continued)

- Right-click on the file you just added

- Choose “SVN Commit…” to commit it to the Sourceforge MIMES repository:

TortoiseSVN: Add a new file to the repository (continued)

- A window “Enter Log Message” appears:

- Please when adding a new model, always enter a message telling something about your model, documentation, a brief description, and related work.

(Sourceforge automatically saves your contact information and the date/time you commited your file.)

- Click “OK”

TortoiseSVN: Add a new file to the

repository (continued)

- This window appears:

- Once it says “Completed”you have added a file to the repository!

- Congratulations!

TortoiseSVN: Add a new file to the

repository (practice)

- To practice this, we have created the folder “TestStuff/” in the Sourceforge subversion repository

- Full location: https://mimes.svn.sourceforge.net/svnroot/mimes/trunk/models/location/TestStuff

- Review this section, adding a file to the “TestStuff/” folder in the repository

TortoiseSVN: Modify an existing file in the

repository

Overview:- “Check out” the folder containing the

file to be modified

- Edit and save the file on your computer

- “Commit” the changes you have made

TortoiseSVN: Modifying a file (continued)

- Checkout appropriate folder from the repository

- Start the “Repo-browser”

(Repository browser)

TortoiseSVN: Modifying a file (continued)

- Choose the folder containing the file you want to edit(Here, have chosen Aesthetic/)

- Right-click on the folder and choose “Checkout…”

- A “Checkout” window appears

TortoiseSVN: Modifying a file (continued)

- Click the “…” next to “Checkout Directory”

- A “Browse for Folder” window appears

- Browse to the folder on your computer where you want to create a local copy of the repository folder

- Create a folder with the same name as the one in the repository

- Click “Make New Folder”- Enter the new folder name

(Here “Aesthetic”)

- Click “OK”

TortoiseSVN: Modifying a file (continued)

- This window appears telling you what has been downloaded:

- The folder you created now looks like this:

- It contains the files from the repository

- Double-click the file you want to open

- Edit the file (In Simile, for example)

- Save it

- The file now appears like this:

(This means it has been modified but changes have not been “committed” to the repository.)

TortoiseSVN: Modifying a file (continued)

- Right-click the file you want to commit

- Choose “SVN Commit…”

TortoiseSVN: Modifying a file (continued)

TortoiseSVN: Modifying a file (continued)

- A window “Enter Log Message” appears:

- Please when modifying a model, always enter a message telling something about what you did to the model, and links to other related changes in the model, documentation, or research.

(Sourceforge automatically saves your contact information and the date/time you commited your file.)

- Click “OK”

TortoiseSVN: Modifying a file (continued)

- This window appears:

- Once it says “Completed”you have modified the repository!

- Congratulations!

TortoiseSVN: Modifying a file (practice)

- To practice this, we have created the folder “TestStuff/” in the Sourceforge subversion repository

- Full location: https://mimes.svn.sourceforge.net/svnroot/mimes/trunk/models/location/TestStuff

- Review this section, modifying a file in the “TestStuff/” folder in the repository

Next steps:

- Download and install Simile Evaluation Edition:http://simulistics.com/products/simile.php(Go to the bottom, where it says “Evaluation

Edition”)

- Complete the 3 Simile tutorials located here:http://simulistics.com/tutorials/index.htm

- Review this presentation and practice adding and modifying models in the TestStuff/ folder

- Contact us if you have questions or problems.