search

openworm / sibernetic

This is a C++/OpenCL implementation of the PCISPH algorithm supplemented with a set of biomechanics related features applied to C. elegans locomotion
Other
353 stars 106 forks source link

More config file variable docs #102

Open nmsutton opened 8 years ago

nmsutton commented 8 years ago

Documentation explaining what each variable represents in configuration files for developers. For instance:

[position] - contains information about position of all particles e.g.
a b c d // a is …, b is …, c is …, d is … <--- Add this

Also optional is a description of the minimum required data in such files to create objects in the scene.

nmsutton commented 8 years ago

I have made some progress on the docs but certainly much more remains. The current version is online here. The github repo is availible here. I would appreciate any contributions!

slarson commented 8 years ago

@nmsutton great start. How would you feel about forking the https://github.com/openworm/sibernetic_config_gen repo directly, adding your docs in as a subdirectory, and doing a pull request back in? Or at minimum, let's add some kind of pointer to your docs from that repo in the readme; just so people can start to find it :) Thanks!

nmsutton commented 8 years ago

@Slarson thanks for your outstanding work on this project! I have now forked and submitted a pull, I appreciate your interest in me doing that.