/README.rst

https://github.com/sastraxi/vizier · ReStructuredText · 46 lines · 32 code · 14 blank · 0 comment · 0 complexity · b5d731200960908ce20fa97b8a005c5c MD5 · raw file

  1. ==================================
  2. Vizier: a python reporting library
  3. ==================================
  4. Vizier started as a fork of cairoplot adding multi-page PDF support.
  5. Since then, the project has been written from the ground-up and re-imagined
  6. to provide a dead-easy reporting and graphing solution for python using cairo.
  7. Notable features include
  8. * bezier line interpolation,
  9. * handling NaN values,
  10. * threshold indicators,
  11. * the creation and management of multi-page documents ("books"), and
  12. * different types of plots (e.g. rectangle, line, scatter) on one graph
  13. I'd like to point you to the fine work of the contributors and maintainers of
  14. the CairoPlot project, who sadly have not had time to continue their work. See
  15. `CairoPlot's project page on Launchpad <https://launchpad.net/cairoplot>`_.
  16. Vizier does not yet provide a comparable level of functionality to cairoplot,
  17. whose sources are available here (in a modified form) by checking out the tag
  18. cairoplot-merged.
  19. Note: libcairo >= 1.10.1 recommended, to fix a bug with multi-page PDF clipping.
  20. https://bugs.freedesktop.org/show_bug.cgi?id=24691
  21. Installing on Windows
  22. =====================
  23. Grab a recent version of GTK+, which includes Cairo. You can download an installer here:
  24. http://sourceforge.net/projects/gtk-win/files/GTK%2B%20Runtime%20Environment/GTK%2B%202.22/
  25. Now, get vizier. In the root vizier directory, run::
  26. python setup.py install
  27. You should now be able to run one of the examples. Try::
  28. python examples/test1.py
  29. If test1.pdf is created and looks slick, you're ready to go!
  30. Quick Example
  31. =============
  32. See examples/test1.py for code that creates a multi-page PDF.