Skip to content

README.md

Latest commit

 

History

History
29 lines (18 loc) · 1.13 KB

README.md

File metadata and controls

29 lines (18 loc) · 1.13 KB

Bubble Plot

The purpose of this Python module is to automate the generation of the CSV file and the preparation of the Latex source file for the bubbleplot Latex package.

How to use the bubble_plot module?

Please follow the instructions of the Jupyter notebook usage_example.ipynb.

WIP

  • Implement, document, and test the bubble plot data generation.
  • Generate the Latex source code parametrised for a given bubble plot.
  • Provide an example of interaction with the bubble_plot module.
  • Document the Latex template variable & keys to manually define.
  • Add support to custom colour scheme for the bubbles (e.g. using seaborn).

To think about:

  • The field years is in the .sty. How to extract it to be configurable?
  • Remove all IO interactions from the bubble_plot module?

Python module documentation

First install sphinx. For example via: pip3 install sphinx.

Then, from docs/ run: make html && open _build/html/index.html

Run tests

Run python3 -m unittest test_bubble_plot.py