Getting started

From QWalkWiki

First go to the documentation page and click on "Graphical class Hierarchy". This is an incredibly useful device that lets you see the major players in the code. Particularly important class types are Method, Wavefunction/Wavefunction_data, Basis_function, and Sample_point/System. These are the ones that have the most children.

Note as of April 2010! We are currently evaluating a Google code page (http://code.google.com/p/qwalk/). There may be more information there than here.

Developing using Mercurial

This is the preferred method of developing. First, you'll need to install Mercurial, which is available for Windows, Linux, and Mac

• Initialize your QWalk development directory:
  • mkdir qwalk_devel
  • hg init
  • hg pull http://altair.physics.ncsu.edu/lkwagner/hg/hgweb.cgi
  • hg update
• Perform your changes and save them to your local repository
  • hg commit
• Keep up-to-date with the mainline by occasionally pulling
  • hg pull http://altair.physics.ncsu.edu/lkwagner/hg/hgweb.cgi
• When you're ready to get your code in the mainline:
  • hg pull http://altair.physics.ncsu.edu/lkwagner/hg/hgweb.cgi
  • hg update
  • Make sure that nothing is broken(i.e., compile and test your code)
  • hg bundle changes.hg http://altair.physics.ncsu.edu/lkwagner/hg/hgweb.cgi
  • email the changes.hg to Lucas as an attachment

• Integrating patches (reminder to the maintainer)
  • hg unbundle changes.hg
  • hg update
• Pushing changes
  • hg push ssh://lkwagner@altair.physics.ncsu.edu//home/httpd/lkwagner/qwalk_main

Submitting patches

• You may wish to let me(Lucas) know what you wish to do. I may be able to give you some pointers or tell you that I'm about to commit the feature anyway.
• Download the latest tarball
• Make your changes
• do the following:
  • cd myqwalkdir
  • diff -ur original_qwalk_dir . > patchfile
• submit the patch file to Lucas, who will hopefully be able to patch it in