https://github.com/dunnl/distributed-systems-art

Haskell diagrams-based Jupyter notebook containing images for a paper
https://github.com/dunnl/distributed-systems-art

Last synced: 7 days ago
JSON representation

Haskell diagrams-based Jupyter notebook containing images for a paper

• Host: GitHub
• URL: https://github.com/dunnl/distributed-systems-art
• Owner: dunnl
• Created: 2024-01-11T22:54:01.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-02-22T16:42:17.000Z (11 months ago)
• Last Synced: 2024-11-15T11:19:19.518Z (2 months ago)
• Language: Jupyter Notebook
• Size: 833 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Distributed Systems Art

This repo contains Haskell code for generating a set of images I am

using in a technical memo.

This repo isn't the most beautiful and elegant solution for what I'm

doing. But it's what I have.

## Layout

There are three main pieces:

- A jupyter notebook containing Haskell diagrams code for live editing

- A Haskell program which, ideally, contains the same Haskell code as the notebook

  The resulting executable, `generator`, is a program that creates rendered Haskell diagrams, typically as `.png` or `.pdf` files

- A simple ruby script that runs `generator` and dumps the rendered diagrams into a directory

## Usage

### The notebook

To launch a jupyter notebook

``` shell

nix run

```

### The generator

``` shell

nix build .#generator

```

followed by

``` shell

./result/bin/generator --help

```

Alternatively,

``` shell

nix run .#generator -- --help

```

Note that the first `--` is used to separate arguments to `nix` and arguments to `generator`.

To work on the Haskell library, launch a development shell with

``` shell

nix develop

```

which provides `cabal-install`, etc.

### The Ruby script

``` shell

nix build .#art

```

The resulting `result/` directory contains the beautiful art