agentsociety2 2.0.0__tar.gz

agentsociety2-2.0.0/.gitignore

@@ -0,0 +1,64 @@
+scientist_demo/
+docs/_build/
+*.mo
+.env
+.python-version
+.venv/
+wheelhouse/
+build/
+.python-version
+log/
+/test
+/test/
+**/test/
+**/tests/
+test_*.py
+*_test.py
+cache/
+ignore/
+*.ipynb*
+*.ipynb*/
+*pycache*
+*pycache*/
+*.DS_Store*
+*.DS_Store*/
+dist/
+*egg-info/
+__*
+!__init__.py
+TODO
+agentsociety-sim
+agentsociety-ui
+agentsociety_data/
+.agentsociety-benchmark/
+logs/
+*.txt
+*.pb
+*.pb.*
+venv_arm/
+mobibench/
+*.pkl
+benchmark_results/
+.agentsociety/
+groundtruth/
+.env.*
+result_commons_tragedy_person_agent/
+result_prisoners_dilemma_person_agent/
+result_public_goods_person_agent/
+result_trust_game_person_agent/
+result_volunteer_dilemma_person_agent/
+game_log/
+*.json
+.vscode/
+*.template
+NEXT_STEPS.md
+PUBLISH_CHECKLIST.md
+
+# Sphinx build outputs
+packages/agentsociety2/docs/_build/
+docs_v1/_build/
+
+# User workspace (may contain API keys)
+workspace/
+packages/agentsociety2/venv/
+packages/agentsociety2/.chainlit/

agentsociety2-2.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [2025] [FIB LAB, Tsinghua University]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

agentsociety2-2.0.0/PKG-INFO

@@ -0,0 +1,427 @@
+Metadata-Version: 2.4
+Name: agentsociety2
+Version: 2.0.0
+Summary: A modern, LLM-native agent simulation platform for social science research
+Project-URL: Homepage, https://github.com/tsinghua-fib-lab/agentsociety
+Project-URL: Documentation, https://agentsociety2.readthedocs.io/
+Project-URL: Repository, https://github.com/tsinghua-fib-lab/agentsociety.git
+Project-URL: Issues, https://github.com/tsinghua-fib-lab/agentsociety/issues
+Project-URL: Changelog, https://github.com/tsinghua-fib-lab/agentsociety/blob/main/CHANGELOG.md
+Author-email: Jun Zhang <zhangjun990222@gmail.com>
+Maintainer-email: Jun Zhang <zhangjun990222@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: agents,artificial-intelligence,experiment,llm,multi-agent,reinforcement-learning,simulation,social-science
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: aiohttp>=3.10.11
+Requires-Dist: aiosqlite>=0.20.0
+Requires-Dist: black>=25.12.0
+Requires-Dist: chromadb>=1.4.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: dill>=0.4.0
+Requires-Dist: doclayout-yolo>=0.0.4
+Requires-Dist: elemental-xenon>=1.1.0
+Requires-Dist: faiss-cpu>=1.7.0
+Requires-Dist: fastapi>=0.128.0
+Requires-Dist: fastmcp>=2.12.2
+Requires-Dist: ftfy>=6.3.1
+Requires-Dist: geojson>=3.1.0
+Requires-Dist: greenlet>=3.0.0
+Requires-Dist: json-repair>=0.46.2
+Requires-Dist: litellm>=1.77.7
+Requires-Dist: mcp[cli]>=1.13.1
+Requires-Dist: mem0ai>=1.0.0
+Requires-Dist: mineru[core]>=1.0.0
+Requires-Dist: numpy<2.0.0,>=1.20.0
+Requires-Dist: pandas>=2.0.0
+Requires-Dist: prompt-toolkit>=3.0.51
+Requires-Dist: pycityproto>=2.4.5
+Requires-Dist: pyclipper>=1.4.0
+Requires-Dist: pydantic>=2.10.4
+Requires-Dist: pyproj>=3.6.0
+Requires-Dist: python-dotenv>=1.0.0
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: qdrant-client>=1.7.0
+Requires-Dist: ruamel-yaml>=0.18.15
+Requires-Dist: shapely>=2.0.6
+Requires-Dist: sqlmodel>=0.0.16
+Requires-Dist: stringcase>=1.2.0
+Requires-Dist: sweetviz>=2.3.0
+Requires-Dist: torch>=2.9.1
+Requires-Dist: transformers>=4.57.3
+Requires-Dist: ultralytics>=8.3.243
+Requires-Dist: uvicorn>=0.35.0
+Requires-Dist: ydata-profiling>=4.6.0
+Provides-Extra: all
+Requires-Dist: furo>=2024.8.6; extra == 'all'
+Requires-Dist: mypy>=1.14.0; extra == 'all'
+Requires-Dist: myst-parser>=4.0.0; extra == 'all'
+Requires-Dist: pre-commit>=3.8.0; extra == 'all'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'all'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'all'
+Requires-Dist: pytest>=9.0.2; extra == 'all'
+Requires-Dist: ruff>=0.11.13; extra == 'all'
+Requires-Dist: sphinx-autobuild>=2024.9.19; extra == 'all'
+Requires-Dist: sphinx-autodoc2>=0.5.0; extra == 'all'
+Requires-Dist: sphinx-intl==2.1.0; extra == 'all'
+Requires-Dist: sphinx>=7.0.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: mypy>=1.14.0; extra == 'dev'
+Requires-Dist: pre-commit>=3.8.0; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov>=5.0.0; extra == 'dev'
+Requires-Dist: pytest>=9.0.2; extra == 'dev'
+Requires-Dist: ruff>=0.11.13; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2024.8.6; extra == 'docs'
+Requires-Dist: myst-parser>=4.0.0; extra == 'docs'
+Requires-Dist: sphinx-autobuild>=2024.9.19; extra == 'docs'
+Requires-Dist: sphinx-autodoc2>=0.5.0; extra == 'docs'
+Requires-Dist: sphinx-intl==2.1.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0.0; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# AgentSociety 2
+
+[![PyPI Version](https://img.shields.io/pypi/v/agentsociety2.svg)](https://pypi.org/project/agentsociety2/)
+[![Python Version](https://img.shields.io/pypi/pyversions/agentsociety2.svg)](https://pypi.org/project/agentsociety2/)
+[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](LICENSE)
+[![Documentation](https://img.shields.io/badge/docs-latest-brightgreen.svg)](https://agentsociety2.readthedocs.io/)
+[![中文文档](https://img.shields.io/badge/docs-%E4%B8%AD%E6%96%87-red.svg)](https://agentsociety2.readthedocs.io/zh_CN/latest/)
+
+> **AgentSociety 2** is a modern, LLM-native agent simulation platform designed for social science research and experimentation.
+
+## Features
+
+- **LLM-Native Design**: Built from the ground up for LLM-driven agents
+- **Flexible Environment System**: Modular environment components with hot-pluggable tools
+- **Multiple Reasoning Patterns**: ReAct, Plan-Execute, Code Generation, and Two-Tier routers
+- **Developer-Friendly**: Pythonic API with type hints and comprehensive documentation
+- **Experiment Replay**: Full SQLite-based replay system for analysis and debugging
+- **MCP Support**: Model Context Protocol integration for tool extensibility
+
+## Installation
+
+```bash
+pip install agentsociety2
+```
+
+### Requirements
+
+- Python >= 3.11
+- An LLM API key (OpenAI, Anthropic, or any provider supported by litellm)
+
+## Quick Start
+
+### Create Your First Agent
+
+```python
+import asyncio
+from datetime import datetime
+from agentsociety2 import PersonAgent
+from agentsociety2.env import CodeGenRouter
+from agentsociety2.contrib.env import SimpleSocialSpace
+from agentsociety2.society import AgentSociety
+
+async def main():
+    # Create an agent with a profile
+    agent = PersonAgent(
+        id=1,
+        profile={
+            "name": "Alice",
+            "age": 28,
+            "personality": "friendly and curious",
+            "bio": "A software engineer who loves hiking and reading."
+        }
+    )
+
+    # Create environment module with agent info
+    social_env = SimpleSocialSpace(
+        agent_id_name_pairs=[(agent.id, agent.name)]
+    )
+
+    # Create environment router
+    env_router = CodeGenRouter(env_modules=[social_env])
+
+    # Create the society
+    society = AgentSociety(
+        agents=[agent],
+        env_router=env_router,
+        start_t=datetime.now(),
+    )
+
+    # Initialize (sets up agents with environment)
+    await society.init()
+
+    # Query (read-only)
+    response = await society.ask("What's your favorite activity?")
+    print(f"Agent: {response}")
+
+    # Close the society
+    await society.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+### Create a Custom Environment Module
+
+```python
+from agentsociety2.env import EnvBase, tool
+
+class MyCustomEnvironment(EnvBase):
+    """A custom environment module."""
+
+    @tool(readonly=True, kind="observe")
+    def get_weather(self, agent_id: int) -> str:
+        """Get the current weather for an agent."""
+        return "The weather is sunny and 25°C."
+
+    @tool(readonly=False)
+    def set_mood(self, agent_id: int, mood: str) -> str:
+        """Change the mood of an agent."""
+        return f"Agent {agent_id}'s mood is now {mood}."
+
+# Use the custom module
+from agentsociety2.env import ReActRouter
+
+env = ReActRouter()
+env.register_module(MyCustomEnvironment())
+```
+
+### Run a Complete Experiment
+
+```python
+import asyncio
+from datetime import datetime
+from agentsociety2 import PersonAgent
+from agentsociety2.env import CodeGenRouter
+from agentsociety2.contrib.env import SimpleSocialSpace
+from agentsociety2.storage import ReplayWriter
+from agentsociety2.society import AgentSociety
+
+async def main():
+    # Setup replay writer for experiment tracking
+    writer = ReplayWriter("my_experiment.db")
+    await writer.initialize()
+
+    # Create agents first (needed for SimpleSocialSpace)
+    agents = [
+        PersonAgent(id=i, profile={"name": f"Player{i}", "personality": "friendly"})
+        for i in range(1, 4)
+    ]
+
+    # Create environment router
+    env_router = CodeGenRouter(
+        env_modules=[SimpleSocialSpace(
+            agent_id_name_pairs=[(a.id, a.name) for a in agents]
+        )]
+    )
+    env_router.set_replay_writer(writer)
+
+    # Create the society with replay enabled
+    society = AgentSociety(
+        agents=agents,
+        env_router=env_router,
+        start_t=datetime.now(),
+        replay_writer=writer,
+    )
+    await society.init()
+
+    # Query (read-only)
+    answer = await society.ask("What are the names of all agents?")
+    print(f"Answer: {answer}")
+
+    # Intervene (read-write)
+    result = await society.intervene("Set all agents' happiness to 0.8")
+    print(f"Result: {result}")
+
+    await society.close()
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Core Concepts
+
+### Agents
+
+Agents are autonomous entities that interact with environments through LLM-powered reasoning:
+
+- **AgentBase**: Abstract base class for all agents
+- **PersonAgent**: Ready-to-use person agent with memory and personality
+- Agents support two interaction modes:
+  - `ask(question, readonly=True)`: Query without side effects
+  - `intervene(instruction)`: Make changes to the environment
+
+### Environment Modules
+
+Environment modules encapsulate specific functionality through tools:
+
+- **EnvBase**: Base class for creating custom modules
+- **@tool decorator**: Register methods as discoverable tools
+- Tool kinds:
+  - `observe`: Single-parameter observation functions
+  - `statistics`: No-parameter aggregation functions
+  - Regular tools: Full read/write operations
+
+### Routers
+
+Routers mediate agent-environment interactions using different reasoning patterns:
+
+- **ReActRouter**: Reasoning + Acting loop
+- **PlanExecuteRouter**: Plan-first, then execute
+- **CodeGenRouter**: Code generation based tool use
+- **TwoTierReActRouter**: Two-level reasoning hierarchy
+- **TwoTierPlanExecuteRouter**: Two-level planning hierarchy
+
+### Storage
+
+The ReplayWriter system captures all interactions for analysis:
+
+```python
+from agentsociety2.storage import ReplayWriter
+
+writer = ReplayWriter("experiment.db")
+await writer.initialize()
+
+# Framework tables (auto-created):
+# - agent_profile: Agent profiles
+# - agent_status: Agent status over time
+# - agent_dialog: Agent LLM interactions
+
+# Custom tables
+from agentsociety2.storage import ColumnDef, TableSchema
+schema = TableSchema(
+    name="custom_metrics",
+    columns=[
+        ColumnDef(name="metric_id", dtype="INTEGER", primary_key=True),
+        ColumnDef(name="value", dtype="REAL"),
+    ]
+)
+writer.register_table(schema)
+```
+
+## Configuration
+
+Set your LLM API credentials via environment variables:
+
+**Required Configuration**
+
+```bash
+# Default LLM (required - used for most operations)
+export AGENTSOCIETY_LLM_API_KEY="your-api-key"
+export AGENTSOCIETY_LLM_API_BASE="https://api.openai.com/v1"
+export AGENTSOCIETY_LLM_MODEL="gpt-4o-mini"
+```
+
+**Optional Configuration**
+
+For specialized tasks, you can configure separate LLM instances:
+
+```bash
+# Code Generation LLM (for code-related tasks)
+# Falls back to default LLM if not set
+export AGENTSOCIETY_CODER_LLM_API_KEY="your-coder-api-key"
+export AGENTSOCIETY_CODER_LLM_API_BASE="https://api.openai.com/v1"
+export AGENTSOCIETY_CODER_LLM_MODEL="gpt-4o"
+
+# Nano LLM (for high-frequency, low-latency operations)
+# Falls back to default LLM if not set
+export AGENTSOCIETY_NANO_LLM_API_KEY="your-nano-api-key"
+export AGENTSOCIETY_NANO_LLM_API_BASE="https://api.openai.com/v1"
+export AGENTSOCIETY_NANO_LLM_MODEL="gpt-4o-mini"
+
+# Embedding Model (for text embeddings and semantic search)
+# Falls back to default LLM if not set
+export AGENTSOCIETY_EMBEDDING_API_KEY="your-embedding-api-key"
+export AGENTSOCIETY_EMBEDDING_API_BASE="https://api.openai.com/v1"
+export AGENTSOCIETY_EMBEDDING_MODEL="text-embedding-3-small"
+export AGENTSOCIETY_EMBEDDING_DIMS="1536"
+
+# Data directory (optional, default: ./agentsociety_data)
+export AGENTSOCIETY_HOME_DIR="/path/to/your/data"
+```
+
+Or use a `.env` file:
+
+```bash
+cp .env.example .env
+# Edit .env with your credentials
+```
+
+## Examples
+
+The `examples/` directory contains ready-to-run examples:
+
+- `basics/`: Basic agent and environment usage
+- `games/`: Classic game theory simulations
+  - Prisoner's Dilemma
+  - Public Goods Game
+  - Trust Game
+  - Volunteer's Dilemma
+  - Commons Tragedy
+- `advanced/`: Advanced usage patterns
+  - Custom environment modules
+  - Multi-router setups
+  - Experiment replay and analysis
+
+## Documentation
+
+- [English Documentation](https://agentsociety2.readthedocs.io/)
+- [中文文档](https://agentsociety2.readthedocs.io/zh_CN/latest/)
+- [API Reference](https://agentsociety2.readthedocs.io/en/latest/api.html)
+
+## Development
+
+For development and contribution guidelines, see [DEVELOPMENT.md](DEVELOPMENT.md).
+
+### Contributing
+
+We welcome contributions! Please see [CONTRIBUTING.md](CONTRIBUTING.md) for details.
+
+## Citation
+
+If you use AgentSociety 2 in your research, please cite:
+
+```bibtex
+@software{agentsociety2,
+  title = {AgentSociety 2: A Modern LLM-Native Agent Simulation Platform},
+  author = {Zhang, Jun and others},
+  year = {2025},
+  url = {https://github.com/tsinghua-fib-lab/agentsociety}
+}
+```
+
+## License
+
+Apache License 2.0 - see [LICENSE](LICENSE) for details.
+
+## Acknowledgments
+
+AgentSociety 2 builds upon excellent open-source projects:
+
+- [litellm](https://github.com/BerriAI/litellm) - Unified LLM API
+- [mem0ai](https://github.com/mem0ai/mem0) - Memory management
+- [FastAPI](https://fastapi.tiangolo.com/) - Backend API framework
+- [Pydantic](https://docs.pydantic.dev/) - Data validation
+
+## Contact
+
+- **Issues**: [GitHub Issues](https://github.com/tsinghua-fib-lab/agentsociety/issues)
+- **Discussions**: [GitHub Discussions](https://github.com/tsinghua-fib-lab/agentsociety/discussions)
+
+---
+
+For the original AgentSociety (v1.x) focused on city simulation, see the [agentsociety package](https://pypi.org/project/agentsociety/).