Merge pull request #18 from openscm/budgets

Add budget-compatible emissions pathway module

README.md

@@ -99,7 +99,7 @@ Additional dependencies can be installed using
     # To add scipy-related dependencies
     pip install continuous-timeseries[scipy]
 
-    # To add all optionatl dependencies
+    # To add all optional dependencies
     pip install continuous-timeseries[full]
     ```
 

changelog/18.docs.md

@@ -0,0 +1 @@
+Added a tutorial into our support for creating emissions pathways that are compatible with a given budget (see [Budget-compatible emissions pathways](../tutorials/budget_compatible_pathways)).

changelog/18.feature.md

@@ -0,0 +1 @@
+Added [`budget_compatible_pathways`][continuous_timeseries.budget_compatible_pathways] to support the creation of pathways compatible with a given budget.

changelog/18.trivial.md

@@ -0,0 +1 @@
+Added support for rending maths with latex in the docs.

docs/NAVIGATION.md

@@ -10,6 +10,7 @@ See https://oprypin.github.io/mkdocs-literate-nav/
 - [Tutorials](tutorials/index.md)
     - [Timeseries tutorial](tutorials/timeseries_tutorial.py)
     - [Higher-order interpolation](tutorials/higher_order_interpolation.py)
+    - [Budget-compatible emissions pathways](tutorials/budget_compatible_pathways.py)
     - [Continuous timeseries tutorial](tutorials/continuous_timeseries_tutorial.py)
     - [Discrete timeseries tutorial](tutorials/discrete_timeseries_tutorial.py)
 - [Further background](further-background/index.md)

docs/javascripts/katex.js

@@ -0,0 +1,10 @@
+document$.subscribe(({ body }) => {
+  renderMathInElement(body, {
+    delimiters: [
+      { left: "$$",  right: "$$",  display: true },
+      { left: "$",   right: "$",   display: false },
+      { left: "\\(", right: "\\)", display: false },
+      { left: "\\[", right: "\\]", display: true }
+    ],
+  })
+})