May 2013 - IMP-dev - salilab.org

For those of you who write documentation
by Daniel Russel 28 May '13

28 May '13

The number of warnings produced when running doxygen had gotten kind of out of control, making it quite hard to work on the documentation. To address this, various people have been assigned issues to fix their documentation bugs. To make this easier, I've refactored the documentation generation code to make it faster to check on warnings in a particular module. You can now do: - IMP-doc to build the documentation for all of IMP - IMP.core-doc to (re-)build the documentation for just IMP.core (remove doc/html/core/index.html if it has already been generated) This means, that once you make some changes to the documentation of your code, you can run a relatively quick build to make sure nothing broke/look at the result. See the change log (or run "git imp update" for more info). As a side note, if you are in the habit of documenting parameters in doxygen using the \param (or @param) commands, please be very careful. Getting a parameter name wrong, or leaving out a parameter results in a warning, and there are tons of these. This both makes the resulting documentation not very useful and makes it hard for anyone to work on the documentation. And one last note, you are, in general, best off using the latest version of doxygen as important bugs are fixed useful capabilities are added at a pretty rapid clip. It is quite easy to install by downloading from http://ftp.stack.nl/pub/users/dimitri/doxygen-1.8.4.linux.bin.tar.gz (on linux) or via homebrew on a mac. I would like to move towards treating doxygen warnings as errors so as to try to keep it warning free, but we are a ways from that. Thanks.

1 0

git flow -> git imp
by Daniel Russel 09 May '13

09 May '13

I found dealing with the README.md and other required was resulting in me using feature branches less than I would like so I forked git-flow and made an imp-customized version. It is pulled in by the the imp repository so you don't have to install anything. Next time you update imp, rerun setup_git.py and you will have several new commands available: - git imp update: updates the repository and displays any new changes listed in ChangeLog.md - git imp feature start: starts a new feature. It opens an editor (using $EDITOR) to create a README.md and commits it to the new feature branch. - git imp feature finish: finishes a feature. The README.md is used as the commit message for the feature and the README.md file itself is removed. The changes in the branch are rebased against develop as part of the process and then squashed into one commit. let me know if you find the scripts useful and if you encounter any problems.

2 2

Re: [IMP-dev] [imp] problem with euler angles (#303)
by Barak.raveh 06 May '13

06 May '13

Does anyone use Euler angles? The related functions don't work too well (numerical instability) so let us know if you need them / feel like fixing them / ok with getting rid of them / marking then as dangerous On Apr 24, 2013, at 2:53 PM, drussel <notifications(a)github.com> wrote: > Should probably just remove the functions. They are numerically unstable and no one has any interest in fixing them. > > — > Reply to this email directly or view it on GitHub.

5 8

Easygit
by Daniel Russel 03 May '13

03 May '13

I just stumbled upon easygit. It might be something for people who are intimidated by git to try out: <http://people.gnome.org/~newren/eg/git-for-svn-users.html> homebrew includes it.

1 0