Skip to content

Latest commit

 

History

History
204 lines (138 loc) · 6 KB

installation.md

File metadata and controls

204 lines (138 loc) · 6 KB

Environment Setup

Docker quickstart

If you're interested in the quickest way to get a Sire REPL and start playing with the language and you have Docker on your system, you can simply pull the Pallas image found here. That repo has instructions for quickly getting straight into a Sire REPL.

Once you're in the REPL, you should see something this:

<...>
("20_prp","LOADED FROM CACHE!")
("21_par","LOADED FROM CACHE!")
("boot","LOADED FROM CACHE!")

}
} ==== Sire REPL ====
}
} Since input is multi-line, there is currently no input-prompt.
} Just type away!
}

Try entering (add 1 2) and hitting enter.

Let's learn some more Sire now

Prebuilt binary

  1. Install dependencies:

Dependencies:

  • libgmp (GNU Multiple Precision Arithmetic Library)
  • liblmdb (Lightning Memory-Mapped Database)
  • libz (zlib compression library)

On Ubuntu or Debian-based systems, you can install these with:

sudo apt-get update && sudo apt-get install -y \
    libgmp10 \
    liblmdb0 \
    zlib1g

On MacOS, Homebrew is a good option (assumes you have Homebrew installed):

brew install gmp lmdb zlib
  1. Get a prebuilt binary:

Currently we provide the following prebuilt binaries:

Your browser may not prompt to download these files, in which case you can use cURL:

curl -L <URL of your choice here> -o pallas

Make it executable and move it somewhere on your path.

  1. Run the pallas binary to confirm all is well:
$ pallas

Run a Pallas machine

Usage: pallas COMMAND

  Pallas

Available options:
  -h,--help                Show this help text

Available commands:
  sire                     Run a standalone Sire repl.
  save                     Load a sire file and save a seed.
  show                     Print a seed file.
  repl                     Interact with a seed file.
  start                    Resume an idle machine.
  boot                     Boot a machine.
  1. Get a Sire REPL:

Clone the Pallas repository and navigate to its root. Then run:

$ pallas sire sire/prelude.sire
...
...
("prelude","LOADED FROM CACHE!")

}
} ==== Sire REPL ====
}
} Since input is multi-line, there is currently no input-prompt.
} Just type away!
}

(Ctrl-C to get out of the REPL)

Install from source

First off, you'll need the Pallas source code. Clone it from https://github.com/operating-function/pallas. The rest of this guide will assume you're at the root of that repo.

Dependency installation and first-run

If your system does not or cannot run nix, you would need to install the Haskell and its build tool, stack, as well as lmdb and zlib. Once these requirements are satisfied, you can stack install at the root of the Pallas repo.

Because the current runtime is somewhat experimental, enormous time has not been invested into portability just yet. As a result, using nix is the most straightforward way to get Pallas running. (installing and configuring nix is outside the scope of this guide. We recommend using Docker if you're unable to use nix)

Any time you open a new terminal, you must remember to enter the development shell with nix by running:

nix develop

You will forget to do this and wonder why nothing is working. That's probably why.

Once you're in a nix development shell, run the following command to build the Pallas environment:

stack build

This might take a while! When it's done, you should be able to verify all went well by running a simple cog:

stack run pallas boot /tmp/counter sire/demo_count_up.sire
stack run pallas start /tmp/counter

You should see a process that logs a message every second.
Press CTRL-C when you're ready to exit the process.

The pallas command and REPLs

Enter this command in a shell at the root level of the pallas repo (where you've remembered to first run nix develop):

pallas

As of the time of this writing, you'll see the usage hint for the pallas command:

new-network - a test for running pallas machines

Usage: pallas COMMAND

  Let's run pallas.

Available options:
  -h,--help                Show this help text

Available commands:
  term                     Connect to the terminal of a cog.
  open                     Open a terminal's GUI interface.
  sire                     Run a standalone Sire repl.
  save                     Load a sire file and save a seed.
  show                     Print a seed file.
  repl                     Interact with a seed file.
  start                    Resume an idle machine.
  loot                     Run a standalone sire repl.
  boot                     Boot a machine.
  du                       du -ab compatible output for pin state.

We'll more get into booting machines and running cogs soon, but first let's just get a Sire REPL to play with.
While the repl command looks attractive, it's not going to do exactly what you expect.

There is a particular boot sequence required before we have all the necessary tools at hand. Since we want our environment to be hydrated properly, we'll execute the proper boot sequence in order to get a working REPL:

pallas sire sire/prelude.sire

You'll see something like this:

<...>
("20_prp","LOADED FROM CACHE!")
("21_par","LOADED FROM CACHE!")
("boot","LOADED FROM CACHE!")

}
} ==== Sire REPL ====
}
} Since input is multi-line, there is currently no input-prompt.
} Just type away!
}

Try entering (add 1 2) and hitting enter.