Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The Project CA builds upon the material taught in the Multi-Agent Systems course. You will use some additional tools and software to develop your recipe recommendation agent in this project.

Set-Up

VS Code HTML and python

1: GitHub Classroom and Clone the Student Project

Info

Hot Tip: GitHub has a great education package if you sign up with your student email https://education.github.com/pack#offers

  • Join the GitHub classroom via this link: https://classroom.github.com/a/HP8FeZ1CE1TKoZxM . Only one member of your team (the first to join) needs to make a team in the classroom. Please use the following same naming convention : group-n, where n is your group numberas your canvas group.

  • Clone the project repository on your local device: copy the HTTPS link from the GitHub Classroom and execute git clone <COPY PASTE HTTPS LINK HERE> inside a terminal in a folder in your user directory.


2: Install MARBEL

  • You may have already installed Eclipse and the MARBEL plug-in. If so, please check whether you are using the latest version of the plug-in by using the Eclipse menu (Help → Check for Updates). If not, pleasehttps://goalapl.atlassian.net/wiki/spaces/GOAL/pages/2143977473/Download+and+Install+the+MARBEL+Plugin.

  • Launch Eclipse (You can choose to create a new workspace if you like).

  • Go to Window → Preferences (or on Mac: Eclipse → Settings) → MARBEL Runtime and uncheck the box for `Include initial KR updates’.

  • Additionally, navigate to the Logging (should be right above Runtime) and check your logging preferences. The following boxes under Logging should be checked:

    • Under Log Handling “Show an action history whilst debugging”, “Show a console per agent whilst debugging”

    • Under Logging Options “The reasoning cycle separator”, Going to sleep or waking up”, “User-specified actions that have been executed”, “Initializing changes in KR”, “Changes in the KR”

Note

Make sure to set these preferences. Without unchecking the runtime option, it will be hard if not impossible to run your agent in Debug Mode. Checking the logging options will enable saving log files automatically, which will be useful for analyzing your agent’s behavior (conversations) and is needed to collect the required conversation data. Also note your Logging Directory!

  • Import the MARBEL dialog manager project in Eclipse by selecting File → Import → MARBEL Agent Programming → Existing MARBEL Project, clicking Next, browsing to the agent folder in which you cloned the project, and selecting the dialogmngr.mas2g file, clicking Open, and finally, clicking Finish.

Note

Do not check the option Copy into workspace! If you import the project into Eclipse, you should be able to see on what branch you are working in your git repository and be able to make use of git functionality available in Eclipse.


3: Install SIC: Make Virtual Environment

Environment Setup Instructions

Follow these steps to set up your environment for the project:


Step 1: Install Redis and PyAudio

  1. Install Redis:
    Follow the guide here to do the install:
    How to Install Redis on Your Laptop

  2. Install PyAudio:
    Use the instructions provided on the PyPI page:
    PyAudio Installation Guide


Step 2: Install Anaconda or Miniconda

  • If you don’t already have Conda installed, download and install either:


Step 3: Create the Conda Environment

  1. Locate the YAML File:
    The repository contains a pre-configured environment.yaml file for the project.

  2. Create the Environment:
    Open a terminal, navigate to the repository folder, and run:

    Code Block
    conda env create -f environment.yaml
  3. Activate the Environment:
    Once the environment is created, activate it with:

    Code Block
    conda activate PCA25

Step 4: Open the Repository in an IDE

  1. Find the Cloned Repository:
    Navigate to the repository folder on your computer.

  2. Use an IDE (Recommended):

    Hot Tip: JetBrains offers free professional licenses for students. Learn more and apply here:
    JetBrains Free Student Licenses

  3. Set Up the Interpreter in PyCharm:

    • Go to File > Settings > Project > Python Interpreter.

    • Set the interpreter to the Conda environment (PCA25) you created earlier.


Step 5: Verify the Setup

  • Check Redis: Ensure Redis is running as per the guide.

  • Check Environment Activation: Ensure the environment is activated before running the project.

    Code Block
    conda activate PCA25
    

You’re now ready to start working on the project! If you encounter any issues, feel free to ask for assistance. 😊

  • Pasted Graphic 2-20250104-111141.pngImage Added
  • open terminal make sure conda env is activated - got to directory for social-interaction-cloud and install if via pip install ., go back to pca-agent-2025 cd .. then go to sic_applications and pip install .

4: Run it!