GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Version 0.10.2 release notes by murrayrm · Pull Request #1140 · python-control/python-control

Conversation

@murrayrm

@murrayrm murrayrm commented Mar 8, 2025

Copy link
Copy Markdown
Member

This PR contains release notes for version 0.10.2 of the python-control toolbox. This should be the last PR merged before release v0.10.2 (with addition commits if any new functionality is added via other PRs).

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
@murrayrm murrayrm added this to the 0.10.2 milestone Mar 8, 2025
@coveralls

coveralls commented Mar 8, 2025 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown

Coverage Status

coverage: 94.745%. remained the same
when pulling b3d8ce9 on murrayrm:release_notes-07Mar2025
into 2745b12 on python-control:main.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

roryyorke
roryyorke suggested changes Mar 8, 2025
View reviewed changes

@roryyorke roryyorke left a comment •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

3 types typos, one tentative wording suggestion.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread doc/releases/0.10.2-notes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/releases/0.10.2-notes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/releases/0.10.2-notes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/releases/0.10.2-notes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@murrayrm
murrayrm force-pushed the release_notes-07Mar2025 branch from 67c1e66 to 7548738 Compare March 8, 2025 17:40
@slivingston
slivingston self-requested a review March 10, 2025 16:29
bnavigator
bnavigator approved these changes Mar 14, 2025
View reviewed changes

@bnavigator bnavigator left a comment

Copy link
Copy Markdown
Contributor

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
slivingston
slivingston reviewed Mar 14, 2025
View reviewed changes

@slivingston slivingston left a comment

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Excellent!

Not related to this PR but relevant in terms of the docs: pinning docutils at 0.16 is not necessary now because the current sphinx_rtd_theme release is compatible with later versions. I removed the pin from requirements.txt and locally the result looks good to me, though I did not carefully compare it side-by-side with the current case (of docutils pinned at 0.16). If you think this is too risky to do now, OK to wait and make the change after releasing version 0.10.2.

If you have access to the ReadTheDocs admin panel, it is worth checking why a warning banner is not appearing on older versions, as I commented in a recent issue.

While reviewing, I noticed a misprint in the docs: "indexed indexed" appears twice in timeresp.py:

  • python-control/control/timeresp.py

    Line 554 in 394e1c2

    Time evolution of the state vector, indexed indexed by either the
  • python-control/control/timeresp.py

    Line 619 in 394e1c2

    Time evolution of the state vector, indexed indexed by either the

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions
Comment thread doc/releases/0.10.2-notes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/releases/0.10.2-notes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/releases/0.10.2-notes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/releases/0.10.2-notes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/releases/0.10.2-notes.rst Outdated
* `FrequencyResponseData`: use `~FrequencyResponseData.complex` to
access the (squeeze processed) complex frequency response (instead
of the legacy `response` property) and
`~FrequencyResponseData.frdata` to access the 3D frequency response

@slivingston slivingston Mar 14, 2025

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This does not render as a link to frdata for me when I build locally. This is expected because frdata is an attribute, whereas complex is a property. Attributes defined by assignment to self do not have documentation besides the class docstring, whereas the property definitions are functions and thus can have their own docstrings.

You might already be aware of the above, but I wanted to write it out to share my understanding while reviewing this PR.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@slivingston slivingston Mar 14, 2025

Copy link
Copy Markdown
Member

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider changing this to

`FrequencyResponseData.frdata <FrequencyResponseData>`

as it is written in the "Deprecations" section below.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

All reactions

@murrayrm murrayrm Mar 15, 2025 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Member Author

There was a problem hiding this comment.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've made the proposed change, but for future we might consider documenting attributes. This can be done by defining the attribute in the class and using the #: syntax in Sphinx. So something like this:

class FrequencyReponseData():
    ...
    #: Frequency response data array.
    #:
    #: The frequency response at each frequency point.  If 1D, ...
    frdata = None

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

slivingston reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
Comment thread doc/classes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

Comment thread doc/classes.rst Resolved

Uh oh!

There was an error while loading. Please reload this page.

@murrayrm

murrayrm commented Mar 15, 2025

Copy link
Copy Markdown
Member Author

If you have access to the ReadTheDocs admin panel, it is worth checking why a warning banner is not appearing on older versions, #1131 (comment)

I looked into this and the settings are such that we should see warning banners. But we don't. I've added @slivingston as a maintainer in case you have time to look and want to debug.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@slivingston

slivingston commented Mar 15, 2025

Copy link
Copy Markdown
Member

If you have access to the ReadTheDocs admin panel, it is worth checking why a warning banner is not appearing on older versions, #1131 (comment)

I looked into this and the settings are such that we should see warning banners. But we don't. I've added @slivingston as a maintainer in case you have time to look and want to debug.

Thanks. It turns out that ReadTheDocs follows the Semantic Version specification, which states that versions less than 1.0.0 are for "initial development" and not stable. ReadTheDocs allows us to manually declare which version is stable by pushing a branch named stable, which I did. Now viewing older versions or "latest" (!= stable) shows warning banners as we want.

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

slivingston
slivingston approved these changes Mar 15, 2025
View reviewed changes
@murrayrm

murrayrm commented Mar 15, 2025

Copy link
Copy Markdown
Member Author

Thanks for the ReadTheDocs fix, @slivingston. What do we need to do when we make a new release? Copy that release into stable?

All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

@slivingston

slivingston commented Mar 15, 2025

Copy link
Copy Markdown
Member

Thanks for the ReadTheDocs fix, @slivingston. What do we need to do when we make a new release? Copy that release into stable?

Yes. Basically, the branch should point to the same commit as the tag used for the release:

git checkout stable
git merge 0.10.2
git push
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.

murrayrm added 7 commits July 4, 2025 12:10
@murrayrm
first pass at 0.10.2 release notes
53e4c4d
@murrayrm
add NamedSignal documentation + tweak control classes figure
bba4f58
@murrayrm
fix typos pointed out by @roryyorke
245c522
@murrayrm
address @slivingston review + other small fixes, cleanup
1e00f49
@murrayrm
added notes on latest changes for this release
bd129bb
@murrayrm
add disk_margins to release notes
df88566
@murrayrm
add bug fix associated with python-controlgh-1161
b3d8ce9
@murrayrm
murrayrm force-pushed the release_notes-07Mar2025 branch from cd03df9 to b3d8ce9 Compare July 4, 2025 16:14
@murrayrm
murrayrm merged commit 03ae372 into python-control:main Jul 4, 2025
@murrayrm murrayrm mentioned this pull request Jul 13, 2025
model reduction by residualization not implemented or not documented #1168
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@slivingston slivingston slivingston approved these changes
@bnavigator bnavigator bnavigator approved these changes
+1 more reviewer
@roryyorke roryyorke roryyorke requested changes
Reviewers whose approvals may not affect merge requirements

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

0.10.2

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

5 participants

@murrayrm @coveralls @slivingston @roryyorke @bnavigator
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402520 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.