Quickstart
Start using OASIS for social simulations in under 5 minutes
Setup your environment
Learn how to set up OASIS and run your first social simulation.
Installation
You can install OASIS in two ways:
Option 1: Install via pip
Option 1: Install via pip
Option 2: Clone the repository
Option 2: Clone the repository
Running simulations
OASIS supports different types of LLM backends for running simulations. Choose the option that works best for your needs.
Using OpenAI API
Set up your API key
Set up your API key
Add your OpenAI API key to your environment variables:
For Bash (Linux, macOS, Git Bash on Windows):
For Windows Command Prompt:
For Windows PowerShell:
Prepare the user profiles
Prepare the user profiles
If you install with pip
, download this file to your own ./data/reddit/user_data_36.json
directory.
Run a Reddit simulation
Run a Reddit simulation
Execute the Reddit simulation script:
This will start a simulation of user interactions in a Reddit-like environment.
Using local open-source models with VLLM
Set up VLLM
Set up VLLM
-
Install VLLM by following the instructions in the VLLM repository
-
Download a model (e.g., Qwen 2.5) to your local machine:
- Deploy the VLLM API server:
- Test if VLLM is correctly deployed:
Run a Twitter simulation with local models
Run a Twitter simulation with local models
- Edit or write the
scripts/environment/twitter_simulation.py
file to use your VLLM deployment:
- Prepare the user profiles:
If you install with
pip
, download this file to your owndata/twitter_dataset/anonymous_topic_200_1h/False_Business_0.csv
directory. - Run the Twitter simulation: