Skip to content

Mathematical Genealogy Grapher — a tool to build graphs of mathematician advisor-advisee networks

License

Notifications You must be signed in to change notification settings

davidalber/geneagrapher

Repository files navigation

Geneagrapher Continuous Integration Status

Geneagrapher is a tool for building mathematician advisor-advisee genealogies using information from the Mathematics Genealogy Project. The output is either a DOT file, which can be used by Graphviz to visualize the graph, or a JSON structure that you can consume with other software tools. Here's an example of a genealogy built by Geneagrapher and visualized using Graphviz:

Chioniadis math
genealogy

To use this package, you will need to have a Python interpreter on your system and install this package. Additionally, if you want to generate the graph visualization you will need another tool (e.g., Graphviz).

If you want to build a math genealogy more easily, you may want to look at the Geneagrapher notebook. That Observable notebook creates geneagraphs in your browser.

If you want to consume records from the Math Genealogy Project in your own software, you may be interested in geneagrapher-core.

Basic Concepts

The input to the Geneagrapher is a set of starting nodes and traversal directions. Multiple starting nodes may be provided (to produce the combined graph for an academic department's students and professors, for instance).

Starting Nodes

Each individual stored in the Mathematics Genealogy Project's website has a unique integer as an identifier, and this identifier is what is passed to the Geneagrapher to specify a starting node. The identifier is contained in the URL for records in the Mathematics Genealogy Project website. For example, Carl Gauß is ID 18231 and Leonhard Euler is ID 38586.

Before running the Geneagrapher, go to the Mathematics Genealogy Project and gather the identifiers of the starting nodes for the graph you want to build.

Traversal Directions

For each starting node, you instruct Geneagrapher to traverse in the advisor direction, the descendant (i.e., student) direction, or both. For example, if you want to build the graph of a mathematician and all of their students, you would specify the descendant traversal direction for that starting node.

Syntax

When running Geneagrapher, you provide starting nodes on the command line. The syntax for doing this is NODE_ID:TRAVERSAL_DIRECTION, where TRAVERSAL_DIRECTION is a | d, and a and d indicate advisor and descendant traversal, respectively. Here are some examples:

  • Carl Gauß and his advisor graph: 18231:a.
  • Carl Gauß and his descendant graph: 18231:d.
  • Carl Gauß and his advisor and descendant graphs: 18231:ad.

Installation

To install Geneagrapher, you must have Python >= 3.8.1. Geneagrapher is installed by pip. If your system does not have pip, see the instructions here.

Once pip is available on your system, install Geneagrapher with:

pip install geneagrapher

Usage

You can get help by doing

ggrapher --help

Processing the DOT File

To process the generated DOT file, Graphviz is needed. Graphviz installs several programs for processing DOT files. For the Geneagrapher, use the dot program. Let's look at an example.

If the Geneagrapher has generated a file named "graph.dot", a PNG file containing the graph can be created with the following command.

dot -Tpng graph.dot > graph.png

That's really all there is to it. Almost.

By default, dot renders an image with 96dpi. This may not look great on high-resolution displays, so you might want to increase the resolution. You can do this with the -Gdpi flag. For instance, to produce a PNG with 150dpi, you can do

dot -Tpng -Gdpi=150 graph.dot > graph.png

Graphviz can also generate other formats, such as PDF and SVG.

Examples

The examples below demonstrate using ggrapher to generate DOT and JSON files. Graphviz-generated visualizations of the associated graphs are also shown without detailing the commands used to create the visualizations.

Note: the Mathematics Genealogy Project data changes over time, so if the examples below are re-run, the results may look different. The commands, however, will be the same.

Single Node Ancestry: Theodor Zwinger

To produce the ancestry DOT file for Theodor Zwinger and save it in the file zwinger.dot, run the command

ggrapher -o zwinger.dot 125148:a

Zwinger math genealogy

Multiple Node Ancestry: Petrus Ryff and Theodor Zwinger

To produce the combined ancestry DOT file for Petrus Ryff and Theodor Zwinger and save it in the file ryff_zwinger.dot, run the command

ggrapher -o ryff_zwinger.dot 125148:a 130248:a

Ryff-Zwinger math genealogy

Single Node Descendant Graph: Haskell Curry

To produce the descendant DOT file for Haskell Curry and save it in the file curry.dot, run the command

ggrapher -o curry.dot 7398:d

Curry math genealogy descendants

Note that descendant graphs often have a lot of "fan out".

JSON Output

The examples above output DOT files (the default output format). Geneagrapher can also output a JSON structure. To do this for the Maarten (Martin) Wicher Visser Bunder descendant graph, for example, run the command

ggrapher -f json -o bunder.json 15648:d

Note that the output format is specified by the -f flag. The file suffix does not impact the output format.

Bunder math genealogy descendants

Here are the contents of the bunder.json output file:

{
  "start_nodes": [
    15648
  ],
  "status": "complete",
  "nodes": {
    "15648": {
      "id": 15648,
      "name": "Maarten (Martin) Wicher Visser Bunder",
      "institution": "Universiteit van Amsterdam",
      "year": 1969,
      "descendants": [
        139651,
        139649,
        230734
      ],
      "advisors": [
        7398
      ]
    },
    "230734": {
      "id": 230734,
      "name": "Joseph Tonien",
      "institution": "University of Wollongong",
      "year": 2018,
      "descendants": [],
      "advisors": [
        47851,
        15648
      ]
    },
    "139651": {
      "id": 139651,
      "name": "Bruce P. Bates",
      "institution": "University of Wollongong",
      "year": 2001,
      "descendants": [],
      "advisors": [
        139650,
        15648
      ]
    },
    "139649": {
      "id": 139649,
      "name": "Frank P. Prokop",
      "institution": "University of Wollongong",
      "year": 1979,
      "descendants": [],
      "advisors": [
        15648
      ]
    }
  }
}

Technical Details

Previous versions of Geneagrapher made requests directly to the Mathematics Genealogy Project and built the graph in the application. The current version of Geneagrapher, however, makes requests to an intermediate service that is built using geneagrapher-core. This backend service assembles requested graphs and maintains a cache of records.

While the shared cache substantially reduces the number of requests from individuals running Geneagrapher (or the Geneagrapher notebook) and speeds up the graph-building process, it also creates an opportunity for inconsistency between information in the Mathematics Genealogy Project and the cache. This can happen when records are updated in the Mathematics Genealogy Project. Such inconsistencies will automatically be resolved when cached values expire.

About

Mathematical Genealogy Grapher — a tool to build graphs of mathematician advisor-advisee networks

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •