Repository navigation
Defining Roadmap to Slycot 0.7.0 #204
Description
Activity
Thanks for all the work @KybernetikJo. Thanks also @bnavigator for reviewing and merging---I don't have much free time at the moment.
FWIW, you might be interested in python-control/python-control#928 , though I don't know if it's gone anywhere.
Reacted by Ben Greiner and Johannes KaisingerBecause I have less time than expected, I would like to move the addition of the sphinx documentation to a milestone 0.7.0! That includes the movement of examples and also the pytest file structure refactoring.
Otherwise, the PR #202 could become a showstopper for a Slycot 0.6.0 release.In addition, I would like to postpone #208 to milestone 0.7.0
Numpy 2.0.0 is going to have a lot of updates to f2py. It could be a good time to have a fresh look at it.Defining Roadmap to Slycot 0.7.0:
This would be my wish list, but I have to add "Resolve or postpone these issues before releasing 0.7.0."
- Add sphinx documentation Add sphinx doc #202
- Further improvements of docstrings, numpydoc Docstring standards in Slycot #100
- Movement of examples
- Discussing and refactoring of the pytest file structure
- Call by reference thing SLICOT routines alter input parameters #208 (wating for numpy 2.0.0)
- New Wrappers, Subspace Identification (IB) routines #169 (I would like to add SID methods)
- Wheels and build system, Build wheels in CI and publish them #164 (Not sure how helpful I can be. The meson transition of numpy, scipy, pandas and matplotlib was successful, fun read https://labs.quansight.org/blog/building-scipy-with-flang)
Reacted by Ben GreinerSounds good to me! I'd rather get the existing improvements into a 0.6 and get work on a 0.7 started, than waiting for perfection.
What do we really want to have in 0.6 already? Maybe at least a hint, that as of now any wrapper "may or may not" alter input parameters.
Reacted by Alexander Bodenseher and Johannes KaisingerWhat do we really want to have in 0.6 already?
I think all PRs since v0.5.4! Three new wrappers and four existing wrappers have been added to
Slycot/__init__.py.Maybe at least a hint, that as of now any wrapper "may or may not" alter input parameters.
Where do you want to place this hint? Readme.md? Release Notes? Would that be enough?
Current state of Slycot.
Where do you want to place this hint? Readme.md? Release Notes? Would that be enough?
Yes, both is a good idea and would be enough in my eyes.
- changed the title
[-]Defining Roadmap to Slycot 0.6.0[/-][+]Defining Roadmap to Slycot 0.7.0[/+]on Apr 5, 2024 Version 0.7 is out. Please rename and reopen, if you think this discussion is still relevant.
I would like to define a Roadmap to the next version of Slycot. Because with #201 and #203 there will be new routines, I guess the version should be increased to v0.6.0!
First a merge of
would be nice. I can revise #201 and #203 again, but basically the wrappers work.
I guess #200 needs a final decision. Furthermore, some other Slycot routines identified by @roryyorke in #200 may need a fix.
First, I would like to ask if a sphinx documentation is actually desired?
If the answer is yes, I would like to merge a sphinx documentation:
[ ] Add sphinx doc #202. This Draft/PR works and would be a start.After that, the following could be done:
Slycot/slycot/__init__.py, the numbers are out of date (see images attached). Refactor __init__.py #205Slycot/slycot/__init__.py. Refactor __init__.py #205[ ] get rid ofSlycot/slycot/example.py, addSlycot/examplesfolder as in python-control and move all examples over there. (the folder is already in Add sphinx doc #202)analysis.pycloser to numpydoc, Docstring standards in Slycot #100, Change analysis.py to numpydoc style #206 (this file is very different from the numpydoc specification)math.pycloser to numpydoc, Docstring standards in Slycot #100, Change math.py to numpydoc style #211synthesis.pycloser to numpydoc, Docstring standards in Slycot #100, Change synthesis.py to numpydoc style #212 (LGTM)transform.pycloser to numpydoc, Docstring standards in Slycot #100, Change transform.py to numpydoc style #213[ ] define a common test structure[ ] study pytest structure and usage in python-control control pytest[ ] we could add a full example of how to create a wrapper. However, it is quite a bit of work.[ ] a slycot template for a.pyfwould be nice.[ ] a slycot template for a numpydoc would be nice.[ ] finally, discuss and improve the slycot sphinx documentation in general.Remark:
Things that are marked as ~tasks~~ will most likely be postponed to Slycot v0.7!
What do you think?
