New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
More fitting algorithms and type hints #10
More fitting algorithms and type hints #10
Conversation
Added a large collection of fitting algorithms. Type hinted all code. Reformatted all code. Added docstrings to all functions.
Added numpy version requirement. Doc changes to circle_fit.py. Changed input variable format of plot_data_circle to match the fitting algorithms.
If nothing happens here @AlliedToasters I'll release |
hey @nup002 , thanks for all your contributions. I'd be happy to merge as long as I can add your contact info to the contributors list - due to the large number of changes, I won't be able to support the expanded codebase alone.. Is that ok with you? |
@nup002 please fetch the latest README.md and add an email to the Contact section - once you do it, I can build and publish a new release with your changes! |
Hi AlliedToaster, I am very happy to see you here! I was hoping I would not have to release a new circle-fit package. |
@nup002 I am traveling today - once I am able to build and test the library, I will publish 0.2.0 to pypi! Thanks again for your contributions and I'm happy to have you here :) |
@AlliedToasters Thank you for the invitation to collaborate on this repository! I am adding a few more commits, and then it should be ready for version 0.2.0. Note that I have changed the build system from setup.py to pyproject.toml with hatchling, just like it is explained in the official documentation on packaging: https://packaging.python.org/en/latest/tutorials/packaging-projects/ I have also added GitHub Workflows for code style (flake8) and unittests (PyTest). Their results are displayed as badges in the ReadMe together with a few other badges. I have tested that it builds and installs correctly. |
@nup002 v0.2.0 has been released to pypi, thanks a lot for the help!! |
You're welcome! Just a note on the new linting workflow I added, you can run |
This pull request extends the functionality of the
circle-fits
package by implementing 6 additional circle fitting algorithms based on MATLAB implementations by Nikolai Chernov.Other enhancements:
Changes:
hyper_fit()
has been renamed tohyperLSQ()
to homogenize algorithm namesleast_squares_circle()
has been renamed tostandardLSQ()
to homogenize algorithm nameshyper_fit()
orleast_squares_circle()
will only raise a DeprecationWarning in order to not break backwards compatibility.The new algorithms have been added to the demo notebook
demo.ipynb
and the unitteststest.py
.