[[!meta title="Download and install"]]

## Source code

Subplot source code is distributed via the git version control system.
There are two repositories, which are intended to be identical:

* GitLab: <https://gitlab.com/subplot/subplot>
* git.liw.fi: <http://git.liw.fi/subplot/>

Use either according to preference.

## Build and install from source

Subplot is written in the Rust language, and you need the Rust
toolchain and cargo installed. If you have that installed and
configured, you can build and install Subplot from source as follows:

~~~sh
git clone https://gitlab.com/subplot/subplot
cd subplot
cargo build
cargo install --path=.
~~~

Note that in addition to the Rust tools, you'll need the following
installed for Subplot to work, including for running its test suite:

* Python 3 to run the generated test program
* Pandoc to typeset documents
  * for HTML, just Pandoc
  * for PDF, you need a LaTeX supported by Pandoc; on Debian, that's
    the packages `texlive-latex-recommended` and
    `texlive-fonts-recommended`
* `pandoc-citeproc` and `bibtex` for citations in typeset documents;
  on Debian, that's `pandoc-citeproc` for the self-titled binary,
  and `bibtex` is part of `texlive-binaries`.
* GraphViz `dot` program for embedded dot and roadmap graphs in typeset documents;
  on Debian that's in `graphviz`.
* PlantUML to render embedded UML diagrams in documents;
  on Debian that's in `plantuml`.
* librsvg2 command line tools (for including SVGs in typeset documents);
  on Debian that's in `librsvg2-bin`.

The
[`debian/control`](https://gitlab.com/subplot/subplot/-/blob/main/debian/control)
file lists the necessary packages under the `Depends` and
`Build-Depends` headings.

## Debian

There is a Debian package built by CI from every commit. It works on
Debian 10 (buster) and later. We have a script to install it:

~~~sh
curl -s https://gitlab.com/subplot/subplot/-/raw/main/install-debian.sh | sudo bash
~~~

If you'd rather not download a script from the Internet and run it as
root (kudos!), you can do the same steps manually. Add the following
to `/etc/apt/sources.list.d/subplot.list`:

~~~
deb http://ci-prod-controller.vm.liw.fi/debian unstable-ci main
~~~

Then save the following PGP public key as
`/etc/apt/trusted.gpg.d/subplot.asc`:

~~~
-----BEGIN PGP PUBLIC KEY BLOCK-----

mQINBFrLO7kBEADdz6mHstYmKU5Dp6OSjxWtWaqTDOX1sJdmmaIK/9EKVIH0Maxp
5kvVO5G6mULLAjv/kLG0MxasHPrq8I2A/y8AqKAGVL8QelwLjQMIFZ30/VbGQPHS
+T5TZXEnoQtNce1GUhFwJ38ZyjjwHBFV9tSec7rZ2Q3YeM3nNnGPf6DacXGfEOPO
HIN4sXAN2hzNXNjKRzTIvxQseb6nr7afUh/SlZ3yhQOCrIzmYlD7tP9WJe7ofL0p
JY4pDQYw8rT6nC2BE/ioemh84kERCT1vCe+OVFlSRuMlqfEv+ZpKQ+itOmPDQ/lM
jpUm1K2hrW/lWpxT/ZxHKo/w1K36J5WshgMZxfUu5BMCL9LMqMcrXNhNjDMfxDMM
3yBPOvQ4ls6fecOZ/bsFo1p8VzMk/w/eG8vPs5yuNa5XxN95yFMXoOHGb5Xbu8D4
6yiW+Af70LbiSNpGdmNdneiGB2fY38NxBukPw5u3S5qG8HedSmMr1RvSr5kHoAAe
UbOY+BYaaKsTAT7+1skUW1o3FJSqoRKCHAzTsMWC6zzhR8hRn7jVrrguH1hGbqq5
TZSCFQZExuTJ7uXrTLG0WoBXIjB5wWNcSeXn8myUWYB51nJNF4tJBouZOz9JwWGl
kiAQkrHnBttLQWdW9FyjbIoTZMtpvVx+m6ObGTGdGL1cNlLAvWprMXGc+QARAQAB
tDJJY2sgQVBUIHJlcG9zaXRvcnkgc2lnbmluZyBrZXkgKDIwMTgpIDxsaXdAbGl3
LmZpPokCTgQTAQgAOBYhBKL1uyDoXyxUH3O717Wr+TZVS6PGBQJayzu5AhsDBQsJ
CAcCBhUICQoLAgQWAgMBAh4BAheAAAoJELWr+TZVS6PGB5QQANTcikhRUHwt9N4h
dGc/Hp6CbqdshMoWlwpFskttoVDxQG5OAobuZl5XyzGcmja1lT85RGkZFfbca0IZ
LnXOLLSAu51QBkXNaj4OhjK/0uQ+ITrvL6RQSXNgHiUTR/W2XD1GIUq6nBqe2GSN
31S1baYKKVj5QIMsi7Dq8ls3BBXuPCE+xTSaNmGWjes2t9pPidcRvxsksCLY1qgw
P1GFXBeMkBQ29kBP87SUL15SIk7OiQLlEURCy5iRls5rt/YEsdEpRWIb0Tm5Nrjv
2M3VM+iBhfNXTwj0rJ34mlycF1qQmA7YcTEobT7z587GPY0VWzBpQUnEQj7rQWPM
cDYY0b+I6kQ8VKOaL4wVAtE98d7HzFIrIrwhTKufnrWrVDPYsmLZ+LPC1jiF7JBD
SR6Vftb+SdDR9xoE1yRuXbC6IfoW+5/qQNrdQ2mm9BFw5jOonBqchs18HTTf3441
6SWwP9fY3Vi+IZphPPi0Gf85oMStgnv/Wnw6LacEL32ek39Desero/D8iGLZernK
Q2mC9mua5A/bYGVhsNWyURNFkKdbFa+/wW3NfdKYyZnsSfo+jJ2luNewrhAY7Kod
GWXTer9RxzTGA3EXFGvNr+BBOOxSj0SfWTl0Olo7J5dnxof+jLAUS1VHpceHGHps
GSJSdir7NkZidgwoCPA7BTqsb5LN
=dXB0
-----END PGP PUBLIC KEY BLOCK-----
~~~


After that run the following commands to install Subplot:

~~~sh
apt update
apt install subplot
~~~

## Other systems

The Subplot developers all use Debian on the 64-bit Intel
architecture, and don't provide installation packages for other kinds
of systems (other architectures, other operating systems). If you'd
like to help with that, it would be very much welcome!

## When you have Subplot installed

See the [[documentation|docs]] page for how to use Subplot.