Development Procedure

This page outlines the basic steps one should take when adding a new development to the AstroBEAR code.

Test Your Changes

First, you'll want the newest revision of AstroBEAR. You could either make a new repository via hg clone, or pull the newest changeset into your current repository:

hg clone ssh://<username>@clover.pas.rochester.edu//data/repositories/scrambler astrobear

OR

hg pull ssh://<username>@clover.pas.rochester.edu//data/repositories/scrambler

Then make any desired or necessary changes, and compile your problem. Now run it, and check the output. If it still works, then you will want to commit these changes to your local repository. If you added new files that you want to be included you will need to do hg add before hg ci:

hg add <filename(s)>
hg ci -m "comments"

If it did not work, you will have to go back and check everything you have changed, fix it, recompile, rerun, and recheck. If everything works and you have committed your changes, it is time to test the rest of the code with the test suite.

Notify the Administrator to check in Run the Test Suite

If you have code to check in, please first contact the administrator (Baowei or Eddie) and tell the administrator the location of the repository (and the revision number) you want to check in. Make sure you pull and possibly merge any new changesets from /data/repositories/scrambler.

The Administrator Run the Test Suite

1) If everything passes the administrator would update the tests repository with the test results for visual verification - and after visually inspecting the results update the official code repository at /data/repository/scrambler
2) If a test fails the administrator would point you to the reference and simulation images as well as the necessary buildproblem commands (or problem modules and bear2fix commands) etc… to reproduce the failed test and leave it to you to determine why the test failed and to fix any possible bugs so that the test passes before was pushed in the official repository

Summary