Skip to content

QuantEcon Infrastructure Projects

mmcky edited this page Jan 5, 2021 · 4 revisions

Projects

  1. Migration to Jupyter Book: https://python.quantecon.org
  2. Migration to Jupyter Book: https://python-advanced.quantecon.org
  3. Documentation Maintenance

Risks to Schedule:

  1. Import executable code from files (Status: In-Work, PR: https://github.com/executablebooks/MyST-NB/pull/286)

    Mitigation Option: Incorporate code in md files and revert once support is available

  2. Bugs that require software updates during the review phase


Migration to Jupyter Book: https://python.quantecon.org

Step 1: Initial Deployment as MVP

Timeframe: 15th January 2021

Deploy to gh-pages with the following supported:

  1. HTML (publish via GitHub actions)
  2. Download Notebook Support (via sphinx-tojupyter)
  3. Google Colab Execution Support (via sphinx-tojupyter)
  4. PDF support (via browser)

with:

Step 2: Feature Parity with Jupinx

Timeframe: Development of features in February 2021

  • Execution Status / Coverage (Status: No Development Work Allocated Yet) but jupyter-cache does give execution statistics that can be checked as part of weekly maintenance tasks
  • PDF generation via LaTeX

Step 3: TBD

Update lectures to use more jupyter-book features in MyST source files


Migration to Jupyter Book: https://python-advanced.quantecon.org

Current Failing Lectures:

  • amss
  • amss3
  • chang_credible
  • chang_ramsey

Step 1: Initial Deployment as MVP

Timeframe: 6th February 2021

Deploy to gh-pages with the following supported:

  1. HTML (publish via GitHub actions)
  2. Download Notebook Support (via sphinx-tojupyter)
  3. Google Colab Execution Support (via sphinx-tojupyter)
  4. PDF support (via browser)

with:

Step 2: Feature Parity with Jupinx

Timeframe: Development of features in February 2021

See lecture-python project above for details. Once features are developed they can be deployed to both lecture series.


Project: Documentation

Timeline: Ongoing