Pycufsm

This update primarily adds only typing and documentation. However, some changes that have gone along with typing have involved breaking changes.

Breaking Changes
The files in which some functions are located have been rearranged. For example, `signature_ss()` and `m_recommend()` have moved from helpers.py to fsm.py - which both fixes some typing issues and makes more rational sense given that these functions are actually running FSM analyses! All functions still exist - nothing's been removed - but you may need to import them from different locations now.

What's Changed
* Typing and setting docstrings throughout all functions by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/43
* Stricter typing throughout by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/44
* Add angle & rack section tests by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/53
* New, simpler input format by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/54
* Add template structure for documentation by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/56
* Initial documentation content by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/57
* Fix syntax for submodule in readthedocs config by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/58
* Add missing typing_extensions requirement by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/59
* Remove unused myst_parser from sphinx config by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/60
* Fix release module depends by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/94

Dependabots
* Bump pytest from 7.3.1 to 7.3.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/45
* Bump yapf from 0.33.0 to 0.40.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/46
* Bump mypy from 1.3.0 to 1.4.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/51
* Bump yapf from 0.40.0 to 0.40.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/48
* Bump pytest from 7.3.2 to 7.4.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/50
* Bump numpy from 1.24.3 to 1.25.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/47
* Bump scipy from 1.10.1 to 1.11.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/52
* Bump scipy from 1.11.0 to 1.11.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/55
* Bump sphinx from 6.2.1 to 7.0.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/62
* Bump typing-extensions from 4.6.2 to 4.7.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/61
* Bump ipywidgets from 8.0.6 to 8.0.7 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/63
* Bump matplotlib from 3.7.1 to 3.7.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/64
* Bump numpy from 1.25.0 to 1.25.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/65
* Bump cython from 3.0.0b3 to 3.0.0rc1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/66
* Bump cython from 3.0.0rc1 to 3.0.0rc2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/67
* Bump cython from 3.0.0rc2 to 3.0.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/68
* Bump sphinx from 7.0.1 to 7.1.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/69
* Bump pylint from 2.17.4 to 2.17.5 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/70
* Bump numpy from 1.25.1 to 1.25.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/72
* Bump sphinx from 7.1.0 to 7.1.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/73
* Bump mypy from 1.4.1 to 1.5.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/75
* Bump ipywidgets from 8.0.7 to 8.1.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/74
* Bump sphinx from 7.1.2 to 7.2.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/78
* Bump scipy from 1.11.1 to 1.11.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/77
* Bump mypy from 1.5.0 to 1.5.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/76
* Bump sphinx from 7.2.2 to 7.2.3 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/79
* Bump cython from 3.0.0 to 3.0.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/80
* Bump sphinx from 7.2.3 to 7.2.4 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/81
* Bump pytest from 7.4.0 to 7.4.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/83
* Bump sphinx from 7.2.4 to 7.2.5 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/82
* Bump ipywidgets from 8.1.0 to 8.1.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/88
* Bump sphinx from 7.2.5 to 7.2.6 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/87
* Bump pytest from 7.4.1 to 7.4.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/85
* Bump numpy from 1.25.2 to 1.26.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/90
* Bump yapf from 0.40.1 to 0.40.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/92
* Bump typing-extensions from 4.7.1 to 4.8.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/91


**Full Changelog**: https://github.com/ClearCalcs/pyCUFSM/compare/v0.1.2...v0.1.3

This update is another set of efficiency improvements, this time Cythonising and optimising the computation-heavy cFSM functions.

What's Changed
* Bump cython from 3.0.0b2 to 3.0.0b3 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/41
* More analysis optimisation by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/42


**Full Changelog**: https://github.com/ClearCalcs/pyCUFSM/compare/v0.1.1+cufsm504...v0.1.2

v0.1.1+cufsm504
This release is primarily a set of efficiency improvement - both some inherent code improvements to remove some redundant matrix operations, and by implementing Cython in the most computation-heavy analysis functions!

What's Changed
* Bump pylint from 2.17.3 to 2.17.4 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/37
* Bump mypy from 1.2.0 to 1.3.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/38
* Miscellaneous efficiency improvements in analysis.py by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/39
* Cythonize analysis.py -> analysis_c.pyx by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/40


**Full Changelog**: https://github.com/ClearCalcs/pyCUFSM/compare/v0.1.0+cufsm501...v0.1.1+cufsm504

v0.1.0+cufsm501
Initial public release to PyPI package repository. This package now has basic automated validation testing, and all core initial features present and validated for a functional package.

Please file any issues or add any feature requests in our GitHub repository! If you would like to help contribute, any assistance is very welcome, and thank you to everyone who contributed and made this initial release possible!

This package was based upon the Matlab CUFSM v5.01, which is now slightly out-of-date (v5.04 is the most recent). A future update to pyCUFSM will re-sync to the latest upstream Matlab CUFSM updates.

What's Changed
* Update LICENSE to AFL-3.0 by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/1
* Add initial pyCUFSM code by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/2
* Create dependabot.yml by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/3
* Fix Centroid Offset Bug, Set vsCode Defaults by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/4
* Add ability to define a section by a path definition by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/5
* Fix bug in angle of drawn curve path by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/6
* Fix FSM mode normalisation & straight path drawing by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/7
* Minor final fix to path drawing by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/8
* Last fix to path by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/9
* Add n_lengths input to m_recommend() by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/10
* pyCUSFM/plotters.py by joelbenjohn in https://github.com/ClearCalcs/pyCUFSM/pull/12
* Validation file and bug fix in Notebook by joelbenjohn in https://github.com/ClearCalcs/pyCUFSM/pull/13
* updated to add notes on installation from git by someparsa in https://github.com/ClearCalcs/pyCUFSM/pull/16
* package import name matching by someparsa in https://github.com/ClearCalcs/pyCUFSM/pull/18
* Update example_1.py by maderero in https://github.com/ClearCalcs/pyCUFSM/pull/14
* Update python versions, and lint by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/20
* Consistent b_1, b_2 vs b_l, b_r by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/19
* Support specifying n_r on each table row by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/21
* Fix m_recommend if there are no minima by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/22
* Consider thickness in lengths_recommend() by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/23
* Upgrade Python Project Structure by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/26
* Bump matplotlib from 3.7.0 to 3.7.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/27
* Bump pytest from 7.2.1 to 7.3.1 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/28
* Bump pylint from 2.4 to 2.17.2 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/31
* Bump pytest-describe from 2.0.1 to 2.1.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/32
* Bump yapf from 0.32.0 to 0.33.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/30
* Bump mypy from 1.0.1 to 1.2.0 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/29
* Cleanup Jupyter Notebooks files by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/33
* Bump numpy from 1.24.2 to 1.24.3 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/34
* Bump pylint from 2.17.2 to 2.17.3 by dependabot in https://github.com/ClearCalcs/pyCUFSM/pull/35
* Add validation tests for C and Z sections by smith120bh in https://github.com/ClearCalcs/pyCUFSM/pull/36

New Contributors
* smith120bh made their first contribution in https://github.com/ClearCalcs/pyCUFSM/pull/1
* joelbenjohn made their first contribution in https://github.com/ClearCalcs/pyCUFSM/pull/12
* someparsa made their first contribution in https://github.com/ClearCalcs/pyCUFSM/pull/16
* maderero made their first contribution in https://github.com/ClearCalcs/pyCUFSM/pull/14
* dependabot made their first contribution in https://github.com/ClearCalcs/pyCUFSM/pull/27

**Full Changelog**: https://github.com/ClearCalcs/pyCUFSM/commits/v0.1.0+cufsm501