Installation and Setup

Purpose

The Installation and Setup section explains how to prepare your computer to use the ARES system. It is a comprehensive guide that covers everything from checking your computer's hardware to installing the necessary programming tools. Once you complete these steps, you will be able to write and run ARES programs that combine several different languages into one.

Why it exists

ARES is a multi-language system, which means it relies on several different tools to work correctly. It needs a way to understand your code (Node.js), a way to build high-performance programs (C++), and a way to handle data science tasks (Python). The installation process exists to ensure all of these tools are correctly connected on your machine. It provides a simple, structured path to setting up your environment so you don't have to troubleshoot complex errors later.

How it works

The setup process follows a clear set of steps to prepare your environment.

1. Setting the foundation (Node.js). You install the main Node.js runtime, which acts as the "host" for the ARES compiler itself.
2. Preparing the target tools. You ensure that the compilers for the languages you want to use (like g++ for C++ or a Python interpreter) are already installed on your computer.
3. Restoring dependencies. You run a simple command (npm install) that downloads all the specialized ARES tools, like the one that handles the language's grammar.
4. Configuring the System Path. You tell your computer exactly where the ARES tools are located so you can run the ares command from any folder on your machine.
5. Verification. Finally, you run a simple version check to confirm that everything is connected and ready for your first program.

Intuition

Think of installation like preparing a professional workspace for a new project. Before you can start building, you need to make sure you have all the right tools on your workbench (the target compilers), the lights are on (Node.js is running), and you know where every tool is stored (the System Path). Correct preparation is the only way to ensure that when you're ready to start your work, your tools will always respond exactly as you expect.

Implementation details

ARES assumes that your target compilers are already in your system's search path. It does not download these tools for you; it simply connects to them when it needs to run your code.

• Version Requirements: You need Node.js version 18 or newer to ensure the compiler is fast and stable.
• Operating Systems: ARES is designed to work on Windows, Linux, and macOS.

Trace example

This is what happens when you run the setup command npm install:

1. Identify: The system reads a list of all the extra tools the compiler needs (like Chevrotain for the grammar).
2. Download: It retrieves these tools from a global repository.
3. Link: It connects all the pieces together inside the node_modules folder.
4. Finish: It reports that your environment is now "ready" and show you the current version of ARES.

Related entities

• 1_tutorial/01_quickstart.md: Once you have finished the setup, move here to write your first program.
• 6_compiler_and_runtime/08_orchestrator_daemon.md: Explains how the system uses these installed tools to run your programs.