Download & Install

The Atlas software can be installed in two ways: by compiling from source, or by running it via Docker. Docker is the easier option for most users, especially on macOS and Windows.

Choose your platform:

Linux (and Solaris)

Compiling from Source

First, obtain the source code from GitHub:

Shellbash
$ git clone https://github.com/jeffreyadams/atlasofliegroups.git
$ cd atlasofliegroups

To compile the software, you will need a C++ compiler and the standard build tools. On most Linux systems these are available via your package manager:

Shellbash
$ sudo apt-get install build-essential   # Debian/Ubuntu
$ sudo dnf install gcc-c++ make          # Fedora/RHEL

Then build the software:

Shellbash
$ make
Compiling atlas...
Done.
Note

The build requires a C++14-compatible compiler. GCC 5.0 or later and Clang 3.4 or later are both supported.

Using Docker

Docker is the recommended option if you do not want to compile from source. First install Docker for your system, then pull the Atlas image:

Shellbash
$ docker pull jeffreyadams/atlas

Run Atlas inside Docker:

Shellbash
$ docker run -it jeffreyadams/atlas
Loading ../atlas-scripts/basic.at...
atlas> 

File Input and Output in Docker

To share files between your local machine and the Docker container, mount a local directory when starting the container:

Shellbash
$ docker run -it -v /path/to/local/dir:/home/atlas/work jeffreyadams/atlas

Files placed in /path/to/local/dir on your machine will be visible inside the container at /home/atlas/work, and vice versa.

Tip

You can load an Atlas script file directly at startup by passing it as an argument: docker run -it jeffreyadams/atlas atlas -l myscript.at

macOS

See the full macOS installation page for instructions on compiling from source (requires Xcode command-line tools) and using Docker.

Windows

On Windows, Docker is the recommended installation method. See the full Windows installation page for details. Compilation from source on Windows requires WSL2 (Windows Subsystem for Linux).

Verifying the Installation

Once installed, run atlas and you should see the prompt:

Atlas sessionatlas
Loading ../atlas-scripts/basic.at...done
atlas> 

Type ?\n to see a list of built-in commands, or ?help\n to open the help system. To quit, type q or press Ctrl-D.

Warning

If you see an error about missing script files, make sure you are running atlas from within the atlasofliegroups directory, or that the ATLAS_PATH environment variable is set correctly.