ipywardley

Bringing Wardley Map magic to Jupyter notebooks

Introduction

This plugin makes it easy to generate Wardley Maps using Jupyter Notebooks.

It supports a subset of the syntax defined by the Online Wardley Maps service. This simple language can be use to specify the map via the %%wardley cell magic.

Try it out!

Run on or

Installation

First, install Jupyter. Then before running it, install ipywardley. e.g. if you are using pip:

pip install ipywardley

Then, run Jupyter:

jupyter-lab

Usage

Open up a new Python 3 notebook, and use this command to enable the module:

%load_ext ipywardley

Now you can use the %%wardley directive and create maps. See this example notebook for a detailed example of how to do this.

Screenshot

To Do

• Support more of the OWM syntax and features (?=maybe?):
  • [ ] evolution Novel->Emerging->Good->Best and evolution X offering the different sets of x-axis labels.
  • [ ] y-axis Value Chain->Invisible->Visible or y-axis none to make 'Visibility' axis optional.
  • [x] evolve
  • [ ] annotation & annotations?
  • [x] note?
  • [ ] market nodes?
  • [ ] pipeline nodes?
  • [ ] node inertia?
  • [x] +<> links to indicate flow.
  • [ ] +> links to indicate flow.
  • [ ] +< links to indicate flow.
  • [ ] Hot Water+'$0.10'>Kettle flow labels?
  • [ ] build, buy, outsource node augmentation?
  • [ ] submap and related syntax?
  • [ ] pioneer, settler, townplanner areas/boxes?
• [ ] Add 'Uncharted' and 'Industrialised' labels
• [ ] Support rendering from a file, via e.g. %wardley file=example.owm style=plain
• [ ] Make it easier to download the SVG/rendered version?

Development

1. Clone this directory.
2. Set up a virtualenv and activate it.
3. Modify the code.
4. Run flit install
5. Run jupyter-lab and test your changes.
6. Repeat 3-5 ad infinitum.
7. Turn your changes into a pull request.

Making a Release

As per https://flit.pypa.io/en/stable/

1. Update version in \_\_init\_\_.py
2. Commit, tag, push.
3. flit publish

Change Log

• 0.0.7:
  • Switch from plt.grid(visibility=True, ...) to plt.grid(visible=True, ...).
• 0.0.6:
  • Added support for the bluelines +<> within Wardley Maps code.
  • Updated to support additional characters within nodes and evolve code lines
  • Default to 'wardley' style if no style provided.
  • Draw evolve lines within the map.
  • Add the red evolve nodes to the map.
• 0.0.5:
  • Updated the 'b' parameter to 'visibility' as 'b' now depreciated.