(→Potential projects: add a potential project)
(→Unofficial backends: add diagrams-wx)
|(13 intermediate revisions by 5 users not shown)|
Latest revision as of 09:10, 10 April 2016
 1 Potential projects
Looking for something to work on? Try one of these! There are also even more (crazy, potentially impossible) project ideas which can be found on the diagrams Trello board. If you have any questions or want to discuss a potential project, send an email to the mailing list.
 1.1 ggplot
Implementing a "grammar of graphics" should be something at which Haskell excels.
 1.2 Port cool examples to diagrams
There is actually quite a lot of value in taking some existing cool graphics or animations and reimplementing them using diagrams, both as a way to obtain some cool examples for the gallery, and to help drive new features in diagrams or active. (So examples that we would like to be able to describe in diagrams but cannot easily do are particularly interesting---what feature(s) would need to be added to make them possible?)
Some possible sources of inspiration:
- Joachim Breitner's animation of a copying garbage collector
- Cool animation demonstrating the concept of prime numbers with orbiting segments for each natural
- animation of creating a dragon curve fractal by cutting and sliding blocks
- Gosper fractal, aka flowsnake
- Bees and Bombs
- Visual explanation of radians
 1.3 Include animations in the gallery and user manual
We need some sort of infrastdireructure for including animations in the gallery and/or user manual. See https://github.com/diagrams/diagrams-doc/issues/1 .
 1.4 Visualization suite for the Haskell ecosystem
There are potentially tons of visualizations that could benefit both people learning Haskell and Haskell developers. Examples of things we might be able to visualize include:
- cabal build plans (especially failures)
- APIs and API diffs
- algebraic data types
- memory layout/usage of data structures
- graph reduction/lazy evaluation
- maps, folds, filters, zips, etc.
- Functor/Applicative/Monad operations/types
But there are probably lots of other things that make sense too. The idea would be to create some useful standalone tools---potentially even exposed as a web service, to remove the necessity for users to build them---to benefit all Haskell users.
This project of course would require creativity and a good sense of design and data visualization. See Edward Tufte for inspiration.
 1.5 GUI application for creating diagrams interactively
Having a tight feedback loop between coding and seeing the reflected changes in a diagram is important. Right now some of the backends have a "looped" compilation mode, but it's somewhat clunky and still a lot slower than it could be, probably due to overheads of compilation, linking, etc.
The idea would be to develop a GUI application allowing the user to edit diagrams code (either with an in-application editing pane or in their own editor, perhaps using fsnotify to watch for changes) and see the updated diagram immediately. Additional potential features include:
- the ability to "zoom in" on a selected subcomponent to display, instead of always displaying everything in the entire file
- using sliders, input boxes, etc. to interactively display parameterized diagrams, perhaps in a type-directed way (see craftwerk-gtk for inspiration)
- Interactive editing of diagrams, e.g. dragging a displayed component and having an appropriate translation call automatically added to the code, or some other sort of support for interactively generating points, vectors, scaling factors, etc. using mouse input
- Support for developing animations (e.g. with a slider for moving back+forth in time)
Perhaps this could be built on top of GTK and diagrams-cairo, or for maximal platform independence perhaps it could use something like threepenny-gui and diagrams-sunroof.
 1.6 Search for Interesting Diagrams
Inspired by QuickCheck and SmallCheck, the idea is to probe some function that produces a diagram to explore the range of diagrams it can produce. Instead of looking for failures it would be looking for differences (visually, in path complexity, time, space, etc.). Such a tool could be useful for generating galleries displaying the capabilities of some diagram generating function or debugging some function to find inputs that do not produce output in the expected visual range.
 1.7 External Rendering
The idea here would be to allow for special external rendering of some primitive that Diagrams does not support. For instance, it would be nice to be able to express LaTeX expressions and when the backend renders, offload the work externally then incorporate it with the output. There are several dimensions to supporting this well and making it as backend agnostic as possible. Somewhat related is the idea of external layout such as asking GraphViz to layout some structure then doing the rendering based on those positions. At the simplest this is just turning some new primitive into an `Image` primitive on the fly in the `Renderable` instance.
 1.8 Variable Precision
It would be nice to be able to trade off precision of the vector output of some backend with the size of that output. For instance the factorization diagrams are rather large when rendered to SVG, but their size could be cut in half by emitting doubles formatted to two significant digits. There is a nice balance that could be struck at a high level where we ensure that we are always within some fraction of what will likely be a pixel in the final output. Then at the level of the backend we would only need to choose the representation that is the smallest for any particular number.
This could be aided by generalized R2.
 1.9 Auto-generated "simple" prelude
The diagrams library is extremely polymorphic---much too polymorphic for beginning users, perhaps. The goal of this project would be to write some code to automatically generate a module Diagrams.Prelude.Simple which re-exports things from Diagrams.Prelude but with more monomorphic types. This would require obtaining the types of things exported by Diagrams.Prelude, doing some analysis to determine what "simpler" type to use, then outputting the appropriate code. There are some interesting, nontrivial questions to be worked out in terms of how to generate a "simple" type from a more general one. There may even be room for multiple "levels" with successively more polymorphism.
 1.10 Graph drawing
We have a contrib module for drawing trees; we have diagrams-graphviz which can interface with GraphViz to do graph layout. However we are still missing higher-level tools for drawing graphs in general. This might include a language for describing and styling graphs. A big part of it (which would be useful in many contexts) would be building good tools for edge labelling.
 1.11 Do a better job combining envelopes
Add extra intensional information to help do a better job with combining envelopes? e.g. inner and outer bounding boxes, circles, etc. e.g. if the outer bound of one lies completely inside the inner bound of another, the resulting combined envelope can be optimized to not actually do a max operation.
 1.12 Auto-generate "connect the dots" puzzles
You know those "connect-the-dots" activities for kids? It would be fun to take (say) an SVG as input and output a "connect-the-dots" version. Fun for the whole family.
 1.13 DSL for identifying subdiagramsIt would be extremely useful if subdiagrams could be identified using a small combinator DSL. For example,
 1.14 Port potrace to Haskell
See http://potrace.sourceforge.net/ and in particular http://potrace.sourceforge.net/potrace.pdf . There do exist Haskell bindings to potrace but the idea would be to reimplement it directly in Haskell.
 1.15 General curved surfaces in 3D
We have some basic 3D support in the POV-Ray backend, limited to primitives such as boxes, spheres, and cones. It would be good to have a more general, flexible representation of solids, comparable to the flexibility of Cubic Bezier curves in 2D. Examples of suitable representations include bicubic patches, NURBs, and various implicit surface descriptions. The first step is choosing which representation to implement.
A minimal implementation would be able to calculate Envelope and Trace for the new primitives, and to render in at least one Backend (POV-Ray or OpenGL). More interesting methods of constructing surfaces, including CSG, extrusion, and revolution, can follow.
 2 Officially supported backends
 2.1 Native SVG
A Haskell-native backend generating SVG. As of diagrams-0.6 this is the default "out-of-the-box" diagrams backend.
 2.2 Rasterific
A Haskell-native backend generating raster graphics, using the Rasterific package.
 2.3 Cairo
Full-featured backend using cairo.
 2.4 GTK
Backend built on top of the cairo backend for rendering directly to GTK windows.
 2.5 Postscript
Very similar to the Cairo backend but only outputting EPS.
 2.6 PGF
A backend emitting PGF/TikZ TeX code.
 2.7 Canvas
An interactive backend drawing on an HTML5 canvas.
 2.8 HTML5
 3 Unofficial backends
 3.1 PDF
 3.2 GHCJS/canvas
- github repo
- Status: active development
- Participants: Daniil Frumin, Luite Stegeman, Daniel Bergey
 3.3 OpenGL
- github repo
- Status: dormant
- Participants: Daniel Bergey
 3.4 POV-Ray
A POV-Ray backend for 3D diagrams.
- github repo
- Status: Alpha, active development
- Participants: Daniel Bergey
 3.5 HsQML
A backend for painting on a QtQuick Canvas.
 3.6 wxWidgets
Backend built on top of the cairo backend for rendering in wxWidgets (via WxHaskell).
 4 Bitrotted/abandoned/superseded backends
 4.1 LaTeX/TikZ
- original darcs repo by Scott Walck
- updated version by Malte Harder on github
- Yet another version is on Hackage
- Status: dormant
- Participants: Scott Walck, Malte Harder
 4.2 HTML5 canvas
- github repo
- Status: dormant
- Participants: Jan Bracker, Andy Gill, Brent Yorgey
 5 Related packages and tools
 5.1 command-line/interactive
See also an earlier project in a similar direction:
 5.2 Writing
- diagrams-haddock is a tool for embedding diagrams in Haddock documentation.
- BlogLiterately-diagrams is a tool for embedding diagrams in blog posts.
 5.3 Build service
diagrams-builder is a library providing the ability to dynamically interpret diagrams code snippets, including utilities for creating temporary files etc. as needed. Useful for making preprocessing tools for embedding diagrams code in other document formats (e.g. LaTeX).
 5.4 Fonts
The SVGFonts package implements Haskell-native font support (for fonts in the SVG-font format) that can be plugged into diagrams.
 6 Other projects
 6.1 gtk-toy
 6.2 LaTeXgrapher
LaTeXGrapher is a project by Ryan Yates providing a domain-specific language for producing mathematical graphs, backed by the diagrams-postscript backend.
 6.3 hs-logo
Deepak Jois is working on a logo interpreter written in Haskell, using diagrams as a backend.
 7 Packages using diagrams
See the reverse dependencies of diagrams-lib.