Giter VIP home page Giter VIP logo

Penrose npm (scoped) license Build Discord Twitter: @UsePenrose

Penrose is a platform that enables people to create beautiful diagrams just by typing notation in plain text. The goal is to make it easy for non-experts to create and explore high-quality diagrams and provide deeper insight into challenging technical concepts. We aim to democratize the process of creating visual intuition.

Usage

You can try Penrose in your browser without any installation. For a more detailed step-by-step introduction, check out our tutorials. Or, for more reference-style information, take a look at our documentation.

Example

Here's a simple Penrose visualization in the domain of set theory.

It's specified by the following trio of Domain, Substance, and Style programs (with variation MonsoonCaterpillar95943):

  • setTheory.domain:

    type Set
    
    predicate Disjoint(Set s1, Set s2)
    predicate Intersecting(Set s1, Set s2)
    predicate Subset(Set s1, Set s2)
    
  • tree.substance:

    Set A, B, C, D, E, F, G
    
    Subset(B, A)
    Subset(C, A)
    Subset(D, B)
    Subset(E, B)
    Subset(F, C)
    Subset(G, C)
    
    Disjoint(E, D)
    Disjoint(F, G)
    Disjoint(B, C)
    
    AutoLabel All
    
  • venn.style:

    canvas {
      width = 800
      height = 700
    }
    
    forall Set x {
      shape x.icon = Circle { }
      shape x.text = Equation {
        string : x.label
        fontSize : "32px"
      }
      ensure contains(x.icon, x.text)
      encourage norm(x.text.center - x.icon.center) == 0
      layer x.text above x.icon
    }
    
    forall Set x; Set y
    where Subset(x, y) {
      ensure disjoint(y.text, x.icon, 10)
      ensure contains(y.icon, x.icon, 5)
      layer x.icon above y.icon
    }
    
    forall Set x; Set y
    where Disjoint(x, y) {
      ensure disjoint(x.icon, y.icon)
    }
    
    forall Set x; Set y
    where Intersecting(x, y) {
      ensure overlapping(x.icon, y.icon)
      ensure disjoint(y.text, x.icon)
      ensure disjoint(x.text, y.icon)
    }
    

Contributing

See CONTRIBUTING.md.

License

This repository is licensed under the MIT License.

Penrose's Projects

Penrose doesnโ€™t have any public repositories yet.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.