Depict

Depict helps you draw pictures of systems, processes, and concepts of operation (ConOps).

People who need to communicate about complex systems often draw pictures with boxes and arrows to explain, in a given situation: * what things are present, * how they are called, * which of them matter, and * how they are related.

Unfortunately, many people find it hard to make these drawings quickly and legibly with conventional tools. They often struggle to uncross arrows or to keep parts of their drawing from colliding, especially while editing text labels. These challenges also makes the drawings hard to reuse and to maintain over time as ideas and situations evolve.

Depict can help: * concisely describe processes, systems, and concepts of operations * automatically draw pretty, legible, maintainable pictures * extract and reuse portions of previous descriptions

thereby helping you to analyze and tell powerful stories about such systems.

Installation

The simplest way to try depict is to use nix with flakes enabled to run:

bash nix run github:mstone/depict#desktop

This should produce a window similar to the one shown in the screenshot above.

Alternately, if you'd like to run depict without with nix, you'll need to

1. install the minion constraint solver
2. install the cvxpy convex optimization library
3. install a recent Rust compiler
4. ensure that the directory containing the minion executable is on PATH and that PYTHONPATH links to cvxpy.
5. use cargo to build or run one of Depict's sub-packages, like:

bash cargo run -p depict-desktop

Usage/Examples

Depict models systems as hierarchies of interacting processes expressed as partial orders. Each input line describes a chain in this order, which will be drawn as a downward-directed path with labels through this graph. Hence the input line:

person microwave food: open, start, stop / beep : heat person food: eat

says:

• there is a path downward in our model from a process (controller) named person to a process named microwave to a process named food,
• in the space between person and microwave, there are three actions, open, start, and stop, and one feedback, beep,
• in the space between microwave and food, there is one action, heat.
• finally, there is also a direct relationship between person and food consisting of the action: stir.

License

This project is licensed under the [MIT license].

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Depict by you, shall be licensed as MIT, without any additional terms or conditions.