nbpages

Chapter 1.0 Style Guide

• 1.0.1 Further reading
• Markdown Links
  • Space Telescope Science Institute Style Guide
  • Jupyter notebook best practices and style guide
  • Dataquest: An In-Depth Style Guide for Data Science Projects
  • ESRI: Coding Standards for Jupyter Notebook

1.1 Notebook naming and ancillary/generated files

1.2 Notebook Style

• 1.2.1 Headings and subheadings
  • 1.2.1.1 Title
  • 1.2.1.2 Subheadings
  • 1.2.1.3 Orphan headings
  • 1.2.1.4 Keywords
• 1.2.2 Markdown
• 1.2.3 Mathematics

1.3 External Files

• 1.3.1 Figures
• 1.3.2 Data
• 1.3.3 Embedding YouTube video
• Markdown Figures

1.4 Coding Style

• 1.4.1 Design for portability
• 1.4.2 Installations and imports

Chapter 2.0 Usage

2.1 Tagging

• 2.1.1 Tagging cells
  • 2.1.1.1 SIR model without vital dynamics
  • 2.1.1 SIR model without vital dynamics
• 2.1.1 Tagging solutions in code cells
  • 2.1.1.1 Exercise 1.
• Markdown Links
  • Susceptible-Infectious-Recovered (SIR) model
  • Susceptible-Infectious-Recovered (SIR) model
• Tags: differential-equations, SIR-model, compartmental-model, scipy.integrate.solve_ivp, home-activity, class-activity, important-note, exercise

2.2 Examples

• 2.2.1 Repositories using nbpages
• Markdown Links
  • CBE 20255 Introduction to Chemical Engineering Analysis
  • CBE 30338 Chemical Process Control
  • CBE 40455 Process Operations
  • ND Pyomo Cookbook
  • nbpages
  • Controlling Natural Watersheds

2.3 Heirarchical Tagging

• 2.3.1 Examples of Cell Tagging
  • 2.3.1.1 References
  • 2.3.1.2 Some Chemical Engineering Content
  • 2.3.1.3 Homework and Exercises
• 2.3.2 Tags
• 2.3.3 Indexing with defaultdict
• 2.3.4 Sorting
• 2.3.5 Printing
• 2.3.6 Linking to references
• Tags: author::FRB::, author::JEJ::, author::EWT::, author::EWT::diffusion-reaction, concept::Thiele-Modulus, author::FRB::Chapter-1

2.4 Working with Data and Figures

• 2.4.1 Importing data
• 2.4.2 Creating and saving figures
• Figure files used
  • figures/Stock_Data.png

2.5 Lint

• 2.5.1 Orphan headers
• 2.5.2 Embedded HTML
• 2.5.3 Output errors
• Figure files used
  • figures/Stock_Data.png