> For the complete documentation index, see [llms.txt](https://bo-yuan-huang.gitbook.io/ilang/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://bo-yuan-huang.gitbook.io/ilang/start/docker.md).

# ILAng in Docker

[![docker-io](http://dockeri.co/image/byhuang/ilang)](https://hub.docker.com/r/byhuang/ilang)

To provide an easy try-on experience without installing all the dependencies here and there, we provide several docker images with ILAng as well as other useful verification tools installed. The images are available at [Docker Hub](https://hub.docker.com/r/byhuang/ilang).

### For ILAng users

This image has the latest version of ILAng installed with a complete set of all ILAng features (including features-in-development). It also includes [CoSA](https://github.com/cristian-mattarei/CoSA) -- an SMT-based symbolic model checker for hardware designs, with an option to use the [z3](https://github.com/Z3Prover/z3) or [BTOR2](https://github.com/Boolector/btor2tools) as the back-end solver. To get the docker image:

```bash
docker pull byhuang/ilang:latest
```

ILAng and dependencies are installed in the virtual environment `/ibuild/ilang-env`. To initiate the environment settings:

```bash
source init.sh
```

### Demonstrate behavioral equivalence checking

This image provides an example `aes-demo` that demonstrates the use of ILAng in generating verification targets for behavioral equivalence checking. The example contains (1) a Verilog implementation of the AES cryptographic accelerator from OpenCores.org, (2) an ILA model of the AES design, and (3) the refinement relation. It also contains the CoSA model checker for solving the problem. To get the image:

```bash
docker pull byhuang/ilang:posh-demo
```

ILAng and dependencies are installed in the virtual environment `/ibuild/ilang-env`. To initiate the environment settings:

```bash
source init.sh
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://bo-yuan-huang.gitbook.io/ilang/start/docker.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
