search

amanzi / ats-short-course

Files for Amanzi Workshop.
BSD 2-Clause "Simplified" License
12 stars 9 forks source link

Notebook requirements, configuration, and demos #2

Open jd-moulton opened 3 years ago

jd-moulton commented 3 years ago

The Jupyter Notebooks are wonderful, but do have some limitations. It would be great to tap into the expertise here to figure out a reasonable set of requirements, how to configure the notebook to support these requirements (i.e., do we need extensions and if so, which ones), and then include a demo notebook with simple examples covering these requirements.

For example, we could create a subdirectory to work on both the requirements and the demo notebook. The requirements doc could be laid out as

Requirements

Markdown cells

Code cells

daniellivingston commented 3 years ago

Math equations in isolation (standard) Math equations with labels

IIRC, Jupyter should support MathJax by default, and it looks like we can configure some MathJax parameters for equation labels/referencing:

The TeX input processing in MathJax can be configured to add equation numbers to displayed equations automatically. This functionality is turned off by default, but it is easy to configure MathJax to produce automatic equation numbers...

It is also possible to set the tagging to 'all', so that every displayed equation will get a number, regardless of the environment used. You can use \notag or \nonumber to prevent individual equations from being numbered, and \tag{} can be used to override the usual equation number with your own symbol instead...

You can use \label to give an equation an identifier that you can use to refer to it later, and then use \ref or \eqref within your document to insert the actual equation number at that location, as a reference.