Tutorial 1: Basics
Learn All the Basics of Penrose
Last updated
Learn All the Basics of Penrose
Last updated
This is the first diagram we will make together. This is the equivalent of the print("Hello World") program for Penrose. To make any mathematical diagram, we first need to visualize some shapes that we want. In this tutorial, we will learn about how to build a triple (.dsl, .sub, .sty) for a simple diagram containing two circles.
This is what you will achieve at the end of this tutorial. If you are familiar with set theory you may recognize that circles are commonly used to represent sets, and that's exactly what we have here. We have 2 sets without names (we will get to labeling later😬).
Before we dive in, make a fork of this repo which contains the starter code for all of the tutorials, as well as solutions for checking your work. Save it somewhere easy to access, like your Home directory or Desktop!
We will be editing the files provided in the ./code/tutorial1 subfolder of this repo.
It follows naturally that our mathematical domain is Set Theory. Therefore, we can rename our .dsl file to setTheory.dsl.
Recall that a .dsl file defines the possible types of objects in our domain. Essentially, we are teaching Penrose the necessary vocabulary that we use to communicate our concept. For example, recall our example of a house from the introduction. Penrose has no idea that there are objects of type "plant" or "furniture" in a house, but we can describe them to Penrose using the type keyword.
We declare a new type following the syntax of type TYPE_NAME.
For example, if we want Penrose to know that there are objects of type plant, we would do type Plant or type plant. We normally capitalize type names.
The answer is a Set. A set is a type of element in set theory. Therefore in our setTheory.dsl, we write the following line:
And that is all we need for this exercise in .dsl🎉. Now Penrose knows that there are objects of type Set.
If you look closely at the repository, we have a domain file that contains more extensive operations common in Set Theory such as Intersection, Union, Subset, and more.
Since we are visualizing 2 sets, they are substances of this diagram.
We declare a substance by first declaring its type followed by its name. The name will not appear in the diagram unless you choose to label your substances, therefore in this exercise, it doesn't matter how you name your sets.
Now, Penrose will know that you want two substances of type Set in your diagram.🎉
Here we have capitalized Set because we did so in our setTheory.dsl file. If we had writtentype set instead, we would declare our set with set A here. There is no magic here, you define your Penrose world completely.🌎✨
For style, we have a little more work to do. If you are familiar with HTML/CSS, a .sty file is essentially a .css file for your HTML (which would be our .sub file). We will rename our provided .sty file to twoSets.sty.
We first need to specify the dimensions of the canvas that our diagram will be drawn on. To do so, you can write the following code anywhere in twoSets.sty. We recommend using a canvas size of 800x700.
Now, Penrose does not know a set is commonly represented as a circle. We need to style our elements from scratch. This might seem strange, but this way you are given absolute freedom in how you want to represent your substances in the diagram. Your set doesn't have to be a circle, it could be a square, a rectangle, etc. But for this example, we will be representing sets as circles.
The syntax for declaring styles is as follows:
Note that the syntax is very similar to the mathematical way of talking about objects, so it should be pretty natural for people with some background in math. If you don't, that's completely fine too! You can interpret the syntax this way: we go through the substances in the diagram, and for all the substances of type t that we see, we apply the same styling as defined in the { }.
In this case, our Type is Set, and we want all of our sets to be circles. We can make that happen by setting some field of each set to a Shape object. In the example below, we name the field .icon. It could be named whatever you want, .foo, .shape, even .ImALittleTeapot would work, as long as we are assigning it to a Shape object. Penrose will detect the Shape object and use it to render each Set as that object.
So, what are the shapes we can use? Currently, the system supports 12 different shapes, and you can find the specs for every shape here. It is a page that you will visit frequently as you work in Penrose.
This is the specification for the shape Circle, and all the other shapes we have available are documented in the same way. You can see a sample diagram of what the shape looks like, and a table that lists out the different properties you can manipulate.
When we construct the Circle object for our Set, we need to look back at our goal diagram. Our desired circles do not have strokes, therefore we will set strokeWidth: 0.0. For all the other properties that we did not specify, Penrose will choose the best value for them based on optimization, so you do not have to worry.
And that's a wrap!🎉
Now it's time to see all of our hard work (drumroll please🥁)! To compile your Penrose programs (more detailed description here), you need:
Two terminals opened at the Penrose root directory
in the first terminal, run yarn start to launch Penrose on your computer and get the browser window to show up.
The pattern for sending the three files we edited (otherwise known as a triple) to the Penrose server that we just launched in the previous step is as follows:npx roger watch <path-to-sub> <path-to-sty> <path-to-dsl>
So we need to replace each of the <path-to> with the actual path to the triple in the tutorial1 directory. For example, if I had saved the tutorials repo at ~/repos/, then I would run: npx roger watch ~/repos/tutorial/code/tutorial1/twoSets.sub ~/repos/tutorial/code/tutorial1/twoSets.sty ~/repos/tutorial/code/tutorial1/setTheory.dsl
Refresh your Penrose window!
We have now covered the differences between and usage of the .dsl, .sub and sty files. We have provided 3 exercises for you to help solidify the basics. You can work on each of these within the existing files - no need to make new ones. Hint: Make use of the shape specs here.
Since we are not defining all the properties that control how the shape will look on-screen (location, color, etc), Penrose will optimize and make those decisions for you. Therefore when you click the resample button, you will get a new diagram that might have varying appearances, and here we've provided some sample results of the same Penrose program. So do not worry if your diagram does not look the exact same as ours.
Challenge 1: Add another Set to the diagram.
Challenge 2: Keep 3 sets. Represent Set as squares with side equal to 50.0.
Challenge 3: Keep 3 sets. Represent Set as rectangles with strokeWidth equal to 15.
Challenge 4: Keep 3 sets. For each set, represent Set as both a Circle and a Square. There should be 6 objects on your canvas (Hint: you will need to initialize another Shape object!).
After you are done, you can double-check your work with solutions.
For each Penrose diagram, we need three files.
.dsl file which defines the domain.
.sub file which defines the substances of the particular diagram.
.sty file which defines how we want to visually represent the mathematical objects.
We define a type of object in our domain with the pattern type TYPE_NAME in our .dsl.
We define the substances in our diagram by declaring their type and variable name in our .sub.
We define the styles using the syntax forall TYPE_NAME x { /* declarations */ } in our .sty.
Now we are going to start the second tutorial that teaches a set of new skills which will allow you to create more intricate and complex diagrams with Penrose. Take a stretch or a little walk, you're about to be one step closer to being a Penrose expert!😄
