mmf-setup 0.1.1

Python Tools

Sidebar

Contents

• mmf_setup

• Quickstart (TL;DR)

• Installing Tools

• Notes

mmf_setup

This meta-project provides an easy way to install all of the python tools I typically use. It also serves as a fairly minimal example of setting up a package the pip can install, and specifying dependencies.

In particular, I structure it for the following use-cases:

1. Rapid installation and configuration of the tools I need. For example, I often use [Sage Mathcloud](cloud.sagemath.com). Whenever I create a new project, I need to perform some initialization. With this project, it is simply a matter of using pip to install this package, and then using some of the tools.

2. Initial setup of a python distribution on a new computer. This is a little more involved since one needs to first install python (I recommend using Miniconda) and then updating the tools.

3. A place to document various aspects of installing and setting up python and related tools. Some of this is old, but kept here for reference.

Quickstart (TL;DR)

1. Install this package from the source directory, PyPI, etc. with one of the following:

• Directly from PyPI (This will only work once the project is published on PyPI.)

pip install --user mmf_setup

• From Source

  pip install --user hg+https://bitbucket.org/mforbes/python_setup

• From Local Source (Run this from the source directory after you unpack it.)

pip install --user .

Note: these can be run without the --user flag if you want to install them system-wide rather than into site.USER_BASE.

2. To get the notebook tools for Jupyter (IPython) notebooks, execute the following as a code cell in your notebook and then trust the notebook with File/Trust Notebook:

   import mmf_setup; mmf_setup.nbinit()

   This will download and enable the calico extensions, as well as set the theme which is implemented in the output cell so it is stored for use online such as when rendered through NBViewer. One can specify different themes. (Presently only theme='default' and theme='mmf' are supported.)

Installing Tools

The following code will download and install the Calico notebook extensions from here:

import mmf_setup.notebook_configuration
mmf_setup.notebook_configuration.install_extensions()

Notes

Various notes about python, IPython, etc. are stored in the docs folder.