notebooks

Support functions to Support QuantEcon.notebooks

The purpose of these utilities is to implement simple support functions to allow for automatic downloading of any support files (python modules, or data) that may be required to run demonstration notebooks.

Note

Files on the REMOTE Github Server can be organised into folders but they will end up at the root level of when downloaded as a support File

https://github.com/QuantEcon/QuantEcon.notebooks/raw/master/dependencies/mpi/something.py” –> ./something.py

TODO

  1. Write Style guide for QuantEcon.notebook contributions
  2. Write an interface for Dat Server
  3. Platform Agnostic (replace wget usage)
quantecon.util.notebooks.fetch_nb_dependencies(files, repo='https://github.com/QuantEcon/QuantEcon.notebooks', raw='raw', branch='master', folder='dependencies', overwrite=False, verbose=True)[source]

Retrieve raw files from QuantEcon.notebooks or any other Github repo

Parameters:

file_list list or dict

A list of files to specify a collection of filenames A dict of dir : list(files) to specify a directory

repo str, optional(default=REPO)

raw str, optional(defualt=RAW)

This is here in case github changes access to their raw files through web links

branch str, optional(default=BRANCH)

folder str, optional(default=FOLDER)

overwrite bool, optional(default=False)

verbose bool, optional(default=True)