GEFFA docs improved, bugs fixed

tundish on 2008/08/26 21:40

Hi there, just to say you can now download an improved version of GEFFA. This version has (I hope) much clearer documentation, plus some bugs fixed. By the way, can anyone guess what this gives you:

[[]]*3
What happens if you append to one of these elements? Ooof!

If you run the demo, you'll see that the spin routine still doesn't work properly; it's just not as horribly broken as it was. The Verlet integration gives it a life of its own!

I hope you'll still find GEFFA useful, primarily for

Enjoy!

(log in to comment)

Comments

richard on 2008/08/27 00:32:

This project really isn't accessible enough for newcomers. I'd like to see at a minimum some sort of public overview & tutorial, and preferably the entire doc set too.

tundish on 2008/08/27 19:58:

Hi, Richard,

Thanks for taking a look. Yes, I'd like to make the docs more accessible. Can you be more specific as to where you think it's not adequate?

There is a section in the guide which walks through the demo; does it not read well? This code is in a very, very early stage. The only interfaces that aren't likely to change are the three areas mentioned above. I'd like to give it the epydoc treatment; do you see value in that?

I've got some time to spare over the next few days, so if you can give me some pointers I'll see what I can do.

richard on 2008/08/28 01:17:

In short, http://www.thuswise.org/geffa/ has no information about what GEFFA is, does, or how it's used.

tundish on 2008/08/30 00:34:

I've just improved on that: here. There are now much clearer instructions on how to install GEFFA. I've added a FAQ, too.

The documentation now consists of a User Guide, and epydoc pages for the code. The User Guide is a walkthrough of the four main areas where I hope GEFFA may be relied upon by PyWeek developers. For the record, they are:

  • Homogeneous coordinates
  • Debugging/test console
  • Loader of .obj files
  • 3D camera

I'm happy to address any other issues you might think are outstanding.

Cheers!

tundish on 2008/09/06 14:32:

There is now a new version available, in time for the compo. No change to API, just some bugs fixed (so the demo should work properly now!)

I haven't been able to take any time off work, so there are going to be a few late nights ahead ;-) . Good luck everyone!