search

jeanluct / braidlab

Matlab package for analyzing data using braids
GNU General Public License v3.0
23 stars 9 forks source link

Better explanation of databraid in guide #90

Open jeanluct opened 9 years ago

jeanluct commented 9 years ago

Since Marko added the databraid.ftbe function, it became clearer that we need to be careful about distinguishing an open (non-closed) braid (still no good name for that, see #24) and a true closed braid.

As it stands the guide is ok: the example with data is an open braid, but the entropy or complexity is not computed.

But it would be better to expand the databraid section from its current bullet-point form to a more fully fleshed-out section. A worked example would be good, maybe involving a braid from a random walk, showing convergence of the entropy for long times? This would have the benefit of documenting the random walk function. Could also use gencount and verify Sarah's law from her thesis.

mbudisic commented 9 years ago

Added a bit more on databraid.FTBE, but this issue really asks for more detailed examples. Delaying for a future release.

jeanluct commented 9 years ago

After #130, the braid-from-data example in the guide has become a bit awkward, since braidlab issues a warning. To keep things simple I tell the user to turn off the warning in the guide, and explain why later. Still, could be rewritten better: use a first example where the data is a "good" braid, then use the data as an example for a databraid.

mbudisic commented 7 years ago

I think this definitely has to happen soon. It looks like people may be using braidlab more and more (jinx), so we want to be sure that they have a difference between braids and databraids clear from the manual, especially because we don't typically discuss these technicalities in papers on talks.