Update README.md with instructions for running code and accessing data

README.md

@@ -44,7 +44,9 @@ For some experiments, TogetherAI key is required to run the code. Please set the
 conda env config vars set TOGETHER_API_KEY=your_key
 ```
 
-A redis-stack server is required to run the code. Please follow the [instruction](https://redis.io/docs/stack/get-started/install/docker/) to start a redis-stack server or use an existing server. The `REDIS_OM_URL` need to be set before loading and saving agents:
+A redis-stack server is required to run the code. Please follow the [instruction](https://redis.io/docs/stack/get-started/install/docker/) to start a redis-stack server or use an existing server. You can also check [Q&A](/docs/all_the_issues.md) to initiate the redis server with the Sotopia data.
+
+The `REDIS_OM_URL` need to be set before loading and saving agents:
 ```bash
 conda env config vars set REDIS_OM_URL="redis://user:password@host:port"
 ```
@@ -111,7 +113,22 @@ For the complete set of parameters, please check the `sotopia_conf` folder.
 
 To run a large batch of environments, you can change the `ENV_IDS` parameter in `sotopia_conf/run_async_server_in_batch.gin` to a list of environment ids. When `gin.ENV_IDS==[]`, all environments on the DB will be used.
 
-## Getting access to the data
-You can find how to get the data in the [Q&A](/docs/all_the_issues.md) section in the `.\docs` folder.
+## Getting access to your simulation
+After running experiments, you can go to the `examples/redis_stats.ipynb` notebook to check the existing episodes (Episode Log section), as well as calculate the performance.
+
+For the original Sotopia simulation in our paper's experiments, you can find how to get them in the [Q&A](/docs/all_the_issues.md) section in the `.\docs` folder.
+
+## Adding new characters and environments
+You can use the following function with the `**kwargs` being the properties of the `AgentProfile` class. This is the same for the scenarios/environments.
+
+```python
+from sotopia.database.persistent_profile import AgentProfile, EnvironmentProfile
+
+def add_agent_to_database(**kwargs: dict[str, Any]) -> None:
+    agent = AgentProfile(**kwargs)
+    agent.save()
 
-After that, you can go to the `examples/redis_stats.ipynb` notebook to check the existing episodes (Episode Log section), as well as calculate the performance.
+def add_env_profile(**kwargs: dict[str, Any]) -> None:
+    env_profile = EnvironmentProfile(**kwargs)
+    env_profile.save()
+```