Chapter 1 Cleanup

[adowling2]

Chapter 1: Python Primer

https://ndcbe.github.io/data-and-computing/notebooks/01-publish/01-Jupyter-Notebooks.html

• Done
• [x] Make a checklist if an item needs to be fixed

[jkeane14]

Python Primer Homepage:

• [x] Some of the test blocks are hidden and some are not

Notebook 4, Functions and Scope:

• [x] Two-by-two solver not defined in Return Values section

Notebook 7, Python Basics III:

• [x] Error in chemical symbols example, cannot load csv

Notebook 8, Linear Algebra:

• [x] my_array not defined in beginning

Notebook 9, Matplotlib Basics:

• [x] Formatting didn't transfer for equation in beginning

Notebook 10, Manipulating data:

• [x] Data for "stocks" label not defined

Notebook 12, Testing and Debugging:

• [x] Formatting did not transfer in tutorial example

[E-Ream]

Welcome to Jupyter Notebooks and Vocareum

• [x] change title of "First Autograded Submission"?

Python Basics I: Variables, Strings, and Bugs

• [x] the "Bad Bugs" home activity needs to print the incorrect number and hide the 64 cell
• [x] for the second "Integers" home activity it already prints out the solution even with the solution cell hidden

Pseudocode

• Done

Functions and Scope

• [x] Motivating example section just above first home activity, reformat equation
• [x] rerun notebook in return values section and delete autograder cell
• [x] final class activity solution is shown even though the student is supposed to predict the answer

Recursion

• Done

High/Low Guess my Number Game

• Done

Python Basics III: Lists, Dictionaries, Enumeration

• [x] rerun chemical symbol example so there isn't an error

Linear Algebra with Numpy and Scipy

• [x] rerun to get rid of errors from initial run
• [x] for first Integrating Everything Together example, the wrong code is hidden whereas the predicted output should be hidden not the code itself

Visualization with Matplolib

• Done

Manipulating Data with Pandas

• [x] rerun to get rid of error

Functions as Arguments

• [x] get rid of solutions that are shown for examples students are supposed to code

Testing and Debugging in Python

• [x] formatting for highlighted box markdowns for mathematical statements

[E-Ream]

@adowling2 @jkeane14 When we are cleaning up these chapters that have been published on a new branch, do we edit the chapter 01 notebooks or the chapter 01-publish notebooks in jupyter lab?

[adowling2]

01 folder. The notebooks in 01-publish are automatically generated.

[E-Ream]

Note: Chapter 1 Cleanup and cell tagging to remove solutions is completed. We may still have issues with the dollar sign math inside of highlighted box markdowns (i.e. tutorial, home, and class activities) that we need to check on once the cleanup branch is published. These issues do not appear until the notebooks are published on the website.

[adowling2]

@E-Ream

Can we split this notebook in two? Split off "Errors in Linear Systems" and the following content to be its own (short) notebook. You'll also need to split the takeaway messages. The first two items stay with LU decomposition. The last takeaway message stays with Errors in Linear Systems.

[E-Ream]

@adowling2 Yes, I can do that. I'll get to work on it next week.

[E-Ream]

The LU Decomposition notebook 02-03 has been split into 02-03 and 02-03b.

[adowling2]

@E-Ream After a bunch of tinkering today, I got LaTeX in the activity callout boxes working:

https://ndcbe.github.io/data-and-computing/notebooks/01/00-Python-Primer.html

You'll, unfortunately, need to update all of the activity box cells. Click the "Colab" button in the above link to see the new syntax for the cells. Post here with your questions.

[adowling2]

Additional clean-up tasks:

• [x] Pseudocode: Remove "TODO: Add another ..."
• [x] Rename "Functions, Scoping, and Other Fun Stuff" to "Modules and Files"

[adowling2]

@E-Ream I have some ideas I want to try on updating the processing script to automatically formate the home, tutorial, and class activities. Let me prototype a few ideas before you get too far along. I hope to show you a working solution during our meeting this week.

[adowling2]

@E-Ream The updated processing script works! Please add to the agenda for the next meeting reformatting notes. I want to add a new type of callout box.

[adowling2]

Here are more cleanup requests for Chapter 1:

https://ndcbe.github.io/data-and-computing/notebooks/01-publish/07-Matplotlib.html#matplotlib-basics

• [x] Remove "Publication Quality Plots" (this will be a separate page added later)
• [x] Promote "Customizing Plots" and "Plotting Multiple Lines" to level 2 headers
• [x] Add level 2 header "Learning More" and include links to matplotlib documentation
  • [x] Tutorials: https://matplotlib.org/stable/tutorials/index.html
  • [x] Getting Started: https://matplotlib.org/stable/tutorials/introductory/usage.html
  • [x] Examples: https://matplotlib.org/stable/gallery/index.html

All notebooks:

• [x] Remove "CBE 20258. Numerical and Statistical Analysis. Spring 2020." or similar text near the top. I'll update the processing script to inject custom text here.

[adowling2]

• [x] Check the headers on this file. Only the title should have a #. I think there are a few # headers in the middle of the file that should become ##. Subsequent headers may also need an extra #.

/Users/adowling/DowlingLab/Teaching/data-and-computing/notebooks/01-publish/10-Testing-and-Debugging.ipynb:30002: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
/Users/adowling/DowlingLab/Teaching/data-and-computing/notebooks/01-publish/10-Testing-and-Debugging.ipynb:270002: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
/Users/adowling/DowlingLab/Teaching/data-and-computing/notebooks/01-publish/10-Testing-and-Debugging.ipynb:270020: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
/Users/adowling/DowlingLab/Teaching/data-and-computing/notebooks/01-publish/10-Testing-and-Debugging.ipynb:300002: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]
/Users/adowling/DowlingLab/Teaching/data-and-computing/notebooks/01-publish/10-Testing-and-Debugging.ipynb:330002: WARNING: Non-consecutive header level increase; 1 to 3 [myst.header]

[E-Ream]

@adowling2 In reference to the headers on the 01-10 notebook, I had fixed this header issue early last week. Did you republish the chapters before seeing this error or is this for the original publish notebook file?

[adowling2]

These are the headers on the main branch. If we have changes on a branch that have not been merged, those changes are not reflected in the header output I posted.

[E-Ream]

Okay, that makes sense. Thank you.

[adowling2]

A few more issues after publishing Draft 2:

https://ndcbe.github.io/data-and-computing/notebooks/01-publish/07-Matplotlib.html

• [x] Fix links for tutorials, Getting Started, and Examples

[adowling2]

https://ndcbe.github.io/data-and-computing/notebooks/01-publish/01-Jupyter-Notebooks.html

• [x] Note boxes need to be cleaned up. See https://github.com/ndcbe/data-and-computing/issues/43 for more information.