add optics design workbench
Dependencies
- This Addon/workbench runs on:
- [x] Most up to date stable release
- [x] Most up to date development release
- [x] Python 3 compatible
- [x] Qt5 compatible
- [x] Qt5 and Qt6 compatible (uses "import PySide" rather than "import PySide2")
- [x] Is this backward compatible with any previous version of FC? If so, please mention in the README.md
- [x] Does this use 3rd party dependencies?
- [x] numpy
- [x] matplotlib
- [x] atomicwrites
- Please specify if there are any other dependencies below and in the README.md and package.xml files
README.md
- [x] Is Markdown friendly
- [x] Has a Prerequisite or Dependencies section
- [x] Links to a
LICENCEfile (Note: FreeCAD uses LGPL2.1, most people choose that or GPL3) - [x] Has a Screenshot and/or a section for screenshots
- [x] Links to a FreeCAD Forum discussion thread
Misc.
- [x] Do you keep a changelog?
If so, where? in the github release notes - [x] Your Addon has an SVG based Logo?
- [x] Your Addon has a package.xml file?
- [ ] Edit the FreeCAD External Workbenches wiki page
Housekeeping
- [x] Fixed typos in the code using
codespell. We recommend running:codespell -q 3 - [ ] We recommend linting python code with PEP8. See [coding conventions][Code-conventions]
Github Related
- [x] Does your repository use Release tags ?
- [x] Repository has topics which include
FreeCADWorkbenchAddon
Note: if your addon/workbench code doesn't reside on Github, please state the address where it is mentioned
You've specified the wrong branch name here -- you should either change it from "main" to "master" here, or rename your branch (also, please correct the indentation of the branch line). In your README you state a dependency on several other Python modules, but you do not list those dependencies in your package.xml file, so the Addon Manager will not display a prompt allowing users to install them automatically. If you choose to add those, you should add atomicwrites to the ALLOWED_PYTHON_PACKAGES.txt file as part of this PR.
Thanks for noticing and sorry for not realizing the branch name typo and indent...
The required python packages are now listed in the package.xml and atomicwrites is added to the packages list.
Just wanted to ask about the status here; is there anything that I should take care of before being added to the list?
About the open points from the checklist: The workbench is not following strict PEP8 style but is "reasonably close", I would say. If I would create a wiki article now it would be a duplicate of the readme, because there is not much to talk about yet. That's why I would rather add the wiki article when the project has grown to a size that cannot be described in a simple readme anymore.