Skip to content

CDS 110 and CDS 112 Jupyter notebooks #1037

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.

Sign up for GitHub

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

Merged
murrayrm merged 18 commits into from
Aug 11, 2024
Merged

CDS 110 and CDS 112 Jupyter notebooks #1037

Show file tree
Hide file tree
Changes from 17 commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
546a4f1
initial commit of CDS 110, Winter 2024 lectures
murrayrm Jul 7, 2024
1bcdb3a
updated lectures, with fixes, full model code, + colab links
murrayrm Jul 7, 2024
ac7d910
added CDS 112 files
murrayrm Jul 9, 2024
257625e
update CDS 110, L1
murrayrm Jul 27, 2024
d4c75a3
update CDS 110, L2
murrayrm Jul 27, 2024
557f2c2
update CDS 110, L3
murrayrm Jul 27, 2024
cd675aa
update CDS 110, L4a and L4b
murrayrm Jul 27, 2024
ea40713
update CDS 110, L5
murrayrm Jul 27, 2024
7756016
update CDS 110, L6a, L6b, and L6c
murrayrm Jul 27, 2024
563b864
update CDS 110, L7
murrayrm Jul 27, 2024
64e58a3
update CDS 110, L8a and L8b
murrayrm Jul 27, 2024
354f3cc
update CDS 110, L9
murrayrm Jul 27, 2024
e4f2710
change cds112 files names and fix up errors
murrayrm Jul 28, 2024
cf10d95
update Google Colab links, Makefile directions
murrayrm Aug 10, 2024
90b1759
fix typo in kincar.py pointed out by @slivingston
murrayrm Aug 10, 2024
7994bd0
fix small typos
murrayrm Aug 10, 2024
fd3a5e7
fix links in doc/examples.rst
murrayrm Aug 10, 2024
7915c91
address @slivingston review comments
murrayrm Aug 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,3 +42,6 @@ venv/
ENV/
env.bak/
venv.bak/

# Files for MacOS
.DS_Store
6 changes: 6 additions & 0 deletions control/freqplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ def bode_plot(
figure with the correct number and shape of axes, a new figure is
created. The shape of the array must match the shape of the
plotted data.
freq_label: str, optional
Frequency label (defaults to "rad/sec" or "Hertz")
grid : bool, optional
If True, plot grid lines on gain and phase plots. Default is set by
`config.defaults['freqplot.grid']`.
Expand All @@ -168,6 +170,8 @@ def bode_plot(
legend_loc : int or str, optional
Include a legend in the given location. Default is 'center right',
with no legend for a single response. Use False to suppress legend.
magnitude_label : str, optional
Label to use for magnitude axis. Defaults to "Magnitude".
margins_method : str, optional
Method to use in computing margins (see :func:`stability_margins`).
omega_limits : array_like of two values
Expand All @@ -179,6 +183,8 @@ def bode_plot(
Number of samples to use for the frequeny range. Defaults to
config.defaults['freqplot.number_of_samples']. Ignored if data is
not a list of systems.
phase_label : str, optional
Label to use for magnitude axis. Defaults to "Phase [rad]".

@slivingston slivingston Aug 10, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
Label to use for magnitude axis. Defaults to "Phase [rad]".
Label to use for phase axis. Defaults to "Phase [rad]".

plot : bool, optional
(legacy) If given, `bode_plot` returns the legacy return values
of magnitude, phase, and frequency. If False, just return the
Expand Down
17 changes: 16 additions & 1 deletion doc/examples.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ Examples

The source code for the examples below are available in the `examples/`
subdirectory of the source code distribution. They can also be accessed online
via the [python-control GitHub repository](https://github.com/python-control/python-control/tree/master/examples).
via the `python-control GitHub repository <https://github.com/python-control/python-control/tree/master/examples>`_.

@slivingston slivingston Aug 10, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggested change
via the `python-control GitHub repository <https://github.com/python-control/python-control/tree/master/examples>`_.
via the `python-control GitHub repository <https://github.com/python-control/python-control/tree/main/examples>`_.



Python scripts
Expand Down Expand Up @@ -62,3 +62,18 @@ online sources.
simulating_discrete_nonlinear
steering
stochresp

Google Colab Notebooks
======================

A collection of Jupyter notebooks are available on [Google Colab](),

@slivingston slivingston Aug 10, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should [Google Colab]() be a link to somewhere? Also, []() is Markdown syntax, but this looks like a reStructuredText file.

where they can be executed through a web browser:

* `Caltech CDS 110 Google Colab notebooks
<https://drive.google.com/drive/folders/1LI2xWVn1kqrZ5lIcM5Ktxr2B7X730cCj?usp=share_link>`_:
Jupyter notebooks created by Richard Murray for CDS 110 (Analysis
and Design of Feedback Systems) at Caltech.

Note: in order to execute the Jupyter notebooks in this collection,
you will need a Google account that has access to the Google
Colaboratory application.
1 change: 1 addition & 0 deletions examples/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
.ipynb-clean
29 changes: 29 additions & 0 deletions examples/Makefile
View file
Open in desktop

@slivingston slivingston Aug 9, 2024

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

make clean is generally useful, but make post does not seem to be, unless they configure gdrive and rclone similarly. I recommend adding a comment that other users may need to change GDRIVE for their own upload target.

Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Makefile for python-control examples
# RMM, 6 Jul 2024
#
# This makefile allows cleanup and posting of Jupyter notebooks into
# Google Colab.
#
# Files are copied to Google Colab using rclone. In order to copy files to
# Google Colab, you should edit the GDRIVE variable to use the name of the
# drive you have configured in rclone and the path where you want to place
# the files. The default location is set up for the fbsbook.org@gmail.com
# Google Drive account, currently maintained by Richard Murray.

NOTEBOOKS = cds110-L*_*.ipynb cds112-L*_*.ipynb
GDRIVE= fbsbook-gdrive:python-control/public/notebooks

# Clean up notebooks to remove output
clean: .ipynb-clean
.ipynb-clean: $(NOTEBOOKS)
@for i in $?; do \
echo jupyter nbconvert --clear-output clear-metadata $$i; \
jupyter nbconvert \
--ClearMetadataPreprocessor.enabled=True \
--clear-output $$i; \
done
touch $@

# Post Jupyter notebooks on course website
post: .ipynb-clean
rclone copy . $(GDRIVE) --include /cds110-L\*_\*.ipynb
Loading