dankelley / mooring

Design and analysis of oceanographic moorings
https://dankelley.github.io/mooring
4 stars 1 forks source link

rename 'discretise' to 'segmentize' #61

Closed dankelley closed 9 months ago

dankelley commented 9 months ago

I think the function name discretise() is a bit strange. Those parameters given to mooring() are, in fact, discrete. When the user writes wire(length=20), the meaning is a piece of wire of that length. A discrete piece of wire.

I notice in the formative paper on mooring analysis (Moller 1976), which I just located today, the operative word for breaking a wire/chain/etc up into segments is, well, "segment". I like that word. We say a worm has segments, for example.

Since we are still at version 0.something, I don't think there is any problem in changing the name. Therefore, I will likely change discretize() to segmentize() tomorrow.

Moller, Donald A. “A Computer Program for the Design and Static Analysis of Single-Point Subsurface Mooring Systems: NOYFB.” Woods Hole, MA: Woods Hole Oceanographic Institution, June 1976. https://darchive.mblwhoilibrary.org/server/api/core/bitstreams/0f41541c-7db6-5641-8412-02f68276b439/content.

dankelley commented 9 months ago

Done