pycityagent 1.0.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

{pycityagent-1.0.0.dist-info → pycityagent-1.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pycityagent
-Version: 1.0.0
+Version: 1.1.1
 Summary: LLM-based城市模拟器agent构建库
 Author-email: Yuwei Yan <pinkgranite86@gmail.com>
 License: MIT License
@@ -39,7 +39,7 @@ Requires-Dist: geojson >=3.1.0
 Requires-Dist: numpy >=1.26.3
 Requires-Dist: openai >=1.8.0
 Requires-Dist: Pillow >=10.2.0
-Requires-Dist: pycitysim >=1.8.0
+Requires-Dist: pycitysim >=1.12.2
 Requires-Dist: citystreetview >=1.1.0
 Requires-Dist: PyYAML >=6.0.1
 Requires-Dist: Requests >=2.31.0
@@ -60,7 +60,7 @@ Requires-Dist: transitions >=0.9.0
 - ![framwork](./static/framework.png)
 
 ### Workflow of CityAgent
-- ![workflow](./static/workflow.png)
+- ![workflow](./static/workflow_1.png)
 
 ## Hands On - By An Easy Demo
 ### Apply for your App
@@ -92,10 +92,12 @@ citysim_request:
   map_request:
     mongo_coll: map_beijing_extend_20240205
     cache_dir: ./cache
+  route_request: 
+    server: http://api-opencity-2x.fiblab.net:58082
   streetview_request:
     engine: baidumap / googlemap
-    mapAK: your baidumap AK (if baidumap)
-    proxy: your googlemap proxy (if googlemap, optional)
+    mapAK: baidumap api-key (if you use baidumap engine)
+    proxy: googlemap proxy (if you use googlemap engine)
 
 apphub_request:
   hub_url: https://api-opencity-2x.fiblab.net:58080
@@ -106,31 +108,56 @@ apphub_request:
 - Forget about **citysim_request**, let's focus on the other two.
 
 #### LLM_REQUEST
-- As you can tell, the whole CityAgent is based on the LLM, by now, there are three different parts of config items: **text_request**, **img_understand_request** and **img_generate_request**
+- As you can see, the whole CityAgent is based on the LLM, by now, there are three different parts of config items: **text_request**, **img_understand_request** and **img_generate_request**
 - By now, we support [**qwen**](https://tongyi.aliyun.com/) and [**openai**](https://openai.com/)
     - `Notice: Our environments are basically conducted with qwen. If you prefer to use openai, then you may encounter hardships. AND fell free to issue us.`
 - Get your **api_key** and chooce your **model**s
 
-### CITYSIM_REQUEST
-- There are no need to change the 'simulator' and 'map_request' config
-- 'streetview_request': this is the config used for streetview
-  - By now, we support 'baidumap' and 'googlemap'
-  - If you use 'baidumap', then you need to apply for a mapAK
-  - If you use 'googlemap', then you can config your own proxy by 'proxy' attribute
+#### CITYSIM_REQUEST
+- Most of the configuration options in this part are determined, such as **simulator.server**, **map_request.mongo_coll**, **route_request.server**
+- **map_request.cache_dir**: used for storing map data your machine, you can justify the target dir as you wish (**create the dir first**)
+- **streetview_request**: used for obtaining streetview images, by now, we support baidumap engine and googlemap engine
+  - if you choose baidumap engine, you need to get a baidumap api-key
+    ``` yaml
+    streetview_request:
+      engine: baidumap
+      mapAK: xxxx
+    ```
+  - if you choose googlemap engine, you need to provide your proxy address, for example:
+    ``` yaml
+    streetview_request:
+      engine: googlemap
+      proxy: 
+        http: http://xxxx
+        https: https://xxxx
+    ```
 
 #### APPHUB_REQUEST
-- This is basically used to connect with the backend.
+- Used for creating the connection between backend server and client.
 - Put your **app_id** and **app_secret** here.
+  - Create your account and apply in [Opencity website](https://opencity.fiblab.net/)
 
 ### Installation
-- Install from **pip** easily.
-```shell
-pip install pycityagent
-```
+#### PyPI Installation
+  - Install from **pip** easily.
+  ```shell
+  pip install pycityagent
+  ```
+
+#### Install from source code
+- Clone this repo
+- Install required packages
+  ``` shell
+  pip install -r requirements.txt
+  ```
+- Install **libGL.so.1**, if you ara using Linux with a suitable package manager: (apt for instance)
+  ``` shell
+  apt-get install libgl1
+  ```
 
 ### CODE and RUN
 - Check the **example** folder and copy files from it (`Remember replace the config file`)
-- Look at the Demo:
+- Look at the Demo: (A citizen Agent demo)
 ```python
 import yaml
 from pycityagent.simulator import Simulator
@@ -147,7 +174,7 @@ async def main():
     smi = Simulator(config['citysim_request'])
     
     # get the person by person_id, return agent
-    agent = await smi.GetAgent("name_of_agent", 8)
+    agent = await smi.GetCitizenAgent("name_of_agent", 8)
 
     # Help you build unique agent by scratch/profile
     agent.Image.load_scratch('scratch_template.json')
@@ -158,6 +185,7 @@ async def main():
 
     # Connect to apphub so you can interact with your agent in front end
     agent.ConnectToHub(config['apphub_request'])
+    agent.Bind()
 
     # Creat the soul (a LLM processor actually)
     llmConfig = LLMConfig(config['llm_request'])

pycityagent-1.1.1.dist-info/RECORD

@@ -0,0 +1,58 @@
+pycityagent/__init__.py,sha256=UWAMvcctp49-8QaRHr2wuR4mLPNvUQ9ocQaXPVLHonI,186
+pycityagent/agent.py,sha256=FxbQiP1IDhuBQuUI8IQeY8eFbr18NQxCiBefWICGnQc,8165
+pycityagent/agent_citizen.py,sha256=AnU9LTP1vGccO7MIxcCYwT40S5Wd9XexO77xjb_oNDc,4972
+pycityagent/agent_func.py,sha256=_9-68KECa0yi867XsXECT8goAw6VogPtb6ba4lNmHJY,4212
+pycityagent/simulator.py,sha256=pX8jTxXl7w6WA4nliJFht74tY-dhOl8dvRvX0U5G00Y,5200
+pycityagent/ac/__init__.py,sha256=ya2NEJ_GagbNc52uFkmPjTGm9FoFy5pRrhXlm0SCt3s,330
+pycityagent/ac/ac.py,sha256=hln8_Dv05tBLcSXd2yso09Z5hsZkvqYBxk6o-sZKia8,2229
+pycityagent/ac/action.py,sha256=MoJ-czSY8AIPDxUzD8-rLrbZIcomovmHvEkMLCTNOTw,1954
+pycityagent/ac/action_stream.py,sha256=cUqLWBVbluIhuvTVi6kh2GWXuE1tHERRRa29OtvMchA,783
+pycityagent/ac/controled.py,sha256=Q9wLPK0HgUO6w551c6gZNPNwtZMWojG3867m7Oy0cVM,539
+pycityagent/ac/converse.py,sha256=IotnC3kwCcCk8-oOuIJOeYBPCVR9lItjci18TX1GGR0,1252
+pycityagent/ac/hub_actions.py,sha256=iMyGjG5ul2whGllOfGJArvMYAXDCCy4pVmZB4HIWuHU,3226
+pycityagent/ac/idle.py,sha256=TU67IWSN_DM1aCdMf6xkXX5uSTPgFIUCVwvxAxN03e0,504
+pycityagent/ac/shop.py,sha256=i9nReY47wgVOMcmi_wp0W9M_dNoXmHpyEo93mC1K6ok,4095
+pycityagent/ac/sim_actions.py,sha256=dpOnhwwsbdYmNGhTWMHzj38qrZd_h99zJraFj6vkljg,3845
+pycityagent/ac/trip.py,sha256=AGdSgqw5CVFVyu_DPnaOY-fK6fTZsOCiA9aVUIAS9VU,1527
+pycityagent/ac/citizen_actions/controled.py,sha256=co0YG7QMMpX-tpbbW_MasoPGm4RzDxkj3IkXFnsuxss,718
+pycityagent/ac/citizen_actions/converse.py,sha256=ocMFvw-_sOUJmucgQjI87NNTZT9dj9svloiiU2zWDBE,1431
+pycityagent/ac/citizen_actions/idle.py,sha256=zrKx8k6-YyT-4i-ZE8BuhsOJIJmCYGEO1WpUaPxWVWw,683
+pycityagent/ac/citizen_actions/shop.py,sha256=lhrVelTVWF_9oAENStcX2YBgz6-fQaK3hL1OL9cl8uY,4273
+pycityagent/ac/citizen_actions/trip.py,sha256=n_XiKqfYlexoxS4q-tMjf2LhIw9xyUFiQI5vSZjsUrw,1772
+pycityagent/brain/__init__.py,sha256=lTW3TBpCTnuJaTWcaeb6j5QQChGBgmWvmSWOBeZp_AQ,373
+pycityagent/brain/brain.py,sha256=WlIcp79ZbiWL47ubdVeXtUvQmzb0Rzluwq3tT2LjHBo,1067
+pycityagent/brain/brainfc.py,sha256=XoiNUQgP4P7ui9dRZWTfzyzBVTDYZf10XqM7kot0Dbg,252
+pycityagent/brain/memory.py,sha256=MhTO8qzhogi-vA12eN3Y3H8gdflYf01XQmIM92N-RaI,21934
+pycityagent/brain/scheduler.py,sha256=56T78XrIdZb7qdlKPkNB-ibKH36ooEqHyHcp2jlID90,18492
+pycityagent/brain/sence.py,sha256=taHdFT1o6ckK36WLOkyFMdRh72EJHkeBtb90cL4S6Mw,28683
+pycityagent/brain/static.py,sha256=vvPaJGKqTBqNe_N3LTFdDjgjjdeZb5niFrYUhGBsGD4,29081
+pycityagent/brain/persistence/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pycityagent/brain/persistence/social.py,sha256=6hJi14sFm4LOU1JlnX8Vq_jFv7VII1uHDM9lrt7-JDA,27
+pycityagent/brain/persistence/spatial.py,sha256=KShHehHOpvUnqxr12Y1FJF4RgyPjD3QNlWw136-zGR0,549
+pycityagent/brain/reason/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pycityagent/brain/reason/shop.py,sha256=jd0p6MDCNTPxo5j8glopiB501l8AuGP1vFlfDcxX69A,777
+pycityagent/brain/reason/social.py,sha256=6QceFlzrA8FNwKzEvVS2aivSr12rkMbyOFO4mlACCfk,6493
+pycityagent/brain/reason/trip.py,sha256=Slop2IxwZ9KE8ZqMOfYbMAgZ2hUcs4LuesxecoSliPc,1543
+pycityagent/brain/reason/user.py,sha256=m1CQrG_Y-guB0WNeF1pR1HmzyPVrX4qAnuMIRl9-5ig,6412
+pycityagent/brain/retrive/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+pycityagent/brain/retrive/social.py,sha256=EfF_9VCPTnDHBd2c5OmH3L4--07Ctps5HJBpSO3hUAA,135
+pycityagent/cc/__init__.py,sha256=rE3JxxIB36tfYVUbtX9ZZ-TKL2lUhbiOJC1PsWqpIOI,148
+pycityagent/cc/cc.py,sha256=p96ZzNKb6KxUNqPWEi1B7Rf0374oM5nJPwGWdaBYZ6k,4135
+pycityagent/cc/conve.py,sha256=sRhZleIGeAV2m6mWoevwUMx2wD0xLVF5qnCld6pDC2E,150
+pycityagent/cc/idle.py,sha256=RbqwG4BdSpLdZ-_13mLMbUs20q8r5drKB4wNIGWPOZw,474
+pycityagent/cc/shop.py,sha256=9c8XTcUZBV90N_0MF3Gi9jlUS0LqNR3vIazEkK8tA28,149
+pycityagent/cc/trip.py,sha256=ayTUnED7Kq6qiwEfCO_u-Hz6rRFNzBI25dZGUSV5dJY,312
+pycityagent/cc/user.py,sha256=nS9NFfZypvXf-vLzqnYzLc6ek-CS8WALtEb00s1nREI,285
+pycityagent/hubconnector/__init__.py,sha256=O11GJiILTibDUgJiAZxfIZ0kckKvToPUYijd06RQ0iQ,53
+pycityagent/hubconnector/hubconnector.py,sha256=Mbaz9y13O_ZT1dlU5Y-fEuTCaVznzc000ECnqnUxkho,4879
+pycityagent/image/__init__.py,sha256=PIKazmxiXLVbSwXIvau3zAvpynyDgukOdNKzh3Iy5ww,78
+pycityagent/image/image.py,sha256=KyOBoX8I1KSi82lBCBku-NXgXX4gIFHi2cGEe7yQ-lI,5396
+pycityagent/st/__init__.py,sha256=YzsQXrgqRvmoQ4dWqAztAriKd8wvnQVe0FOpX_oZmiY,109
+pycityagent/st/st.py,sha256=z6yDo7ADOjostLg0mLmQ0oa_VysaCXFm4MnzC2H9nsI,5154
+pycityagent/urbanllm/__init__.py,sha256=D24mYFXdIEL2vbvB7Cp_BGgJvg-tvEnCgtEAAGaqGDY,56
+pycityagent/urbanllm/urbanllm.py,sha256=6PHRNSlYHrbHyzC_Pv2An71S7hkm-6XmAN7pJTozwas,4344
+pycityagent-1.1.1.dist-info/LICENSE,sha256=Yo9QmwLDFU3VoOc0W8aYSCa5Yj5sJyqM3FEcbC2jMQQ,1063
+pycityagent-1.1.1.dist-info/METADATA,sha256=mauUBRmAFcENHHhwi8FZ7f8n03ZnZAtdfk8M88YmGiE,7460
+pycityagent-1.1.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+pycityagent-1.1.1.dist-info/top_level.txt,sha256=mf70CsOn3eVJBwHQ_TjCesoc-elD0Bj2WLsi5APRjlU,12
+pycityagent-1.1.1.dist-info/RECORD,,

{pycityagent-1.0.0.dist-info → pycityagent-1.1.1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.42.0)
+Generator: bdist_wheel (0.43.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pycityagent-1.0.0.dist-info/RECORD

@@ -1,48 +0,0 @@
-pycityagent/__init__.py,sha256=AUksztmIqz0WYM9wNuO0WYZCNygPuhnQsRiqDmG3nTA,87
-pycityagent/agent.py,sha256=B_AK49HvdqbTiyvPZ3MRq8XID3qjhkjsywsJ-fNWB6Y,9637
-pycityagent/simulator.py,sha256=PbkgpeE6rwLxXSdEsGd60cc0kzw1zrgv9sifug9zHEU,5542
-pycityagent/ac/__init__.py,sha256=vzDpFox7x96yhhwUro7dWQvv1ztUzNjlnYovLSTV0lQ,141
-pycityagent/ac/ac.py,sha256=l7aas0w4UmSCXoXcSzp7md73zk9aRTxYK0Ev6ep7zMI,1574
-pycityagent/ac/action.py,sha256=MxdDo0BS_dZZgvNTmYK6SSV4oLn0OVdciEb5nBMtMrg,324
-pycityagent/ac/controled.py,sha256=Q9wLPK0HgUO6w551c6gZNPNwtZMWojG3867m7Oy0cVM,539
-pycityagent/ac/converse.py,sha256=IotnC3kwCcCk8-oOuIJOeYBPCVR9lItjci18TX1GGR0,1252
-pycityagent/ac/idle.py,sha256=TU67IWSN_DM1aCdMf6xkXX5uSTPgFIUCVwvxAxN03e0,504
-pycityagent/ac/shop.py,sha256=i9nReY47wgVOMcmi_wp0W9M_dNoXmHpyEo93mC1K6ok,4095
-pycityagent/ac/trip.py,sha256=AGdSgqw5CVFVyu_DPnaOY-fK6fTZsOCiA9aVUIAS9VU,1527
-pycityagent/brain/__init__.py,sha256=3uAqrqRQE6mmhFzcTRygE-J5IxZz6tIWyF4WL1M3iSg,348
-pycityagent/brain/brain.py,sha256=WlIcp79ZbiWL47ubdVeXtUvQmzb0Rzluwq3tT2LjHBo,1067
-pycityagent/brain/brainfc.py,sha256=XoiNUQgP4P7ui9dRZWTfzyzBVTDYZf10XqM7kot0Dbg,252
-pycityagent/brain/memory.py,sha256=7qubt5kmn9lzFD75OwmePhtLXsO_HGYhxlRbbTfJtBY,19125
-pycityagent/brain/scheduler.py,sha256=56T78XrIdZb7qdlKPkNB-ibKH36ooEqHyHcp2jlID90,18492
-pycityagent/brain/sence.py,sha256=TX6t4zn_c8Diwo8UlCmaZ7U4OH4RAmzpZERrTYtcIqA,13715
-pycityagent/brain/static.py,sha256=vvPaJGKqTBqNe_N3LTFdDjgjjdeZb5niFrYUhGBsGD4,29081
-pycityagent/brain/persistence/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pycityagent/brain/persistence/social.py,sha256=6hJi14sFm4LOU1JlnX8Vq_jFv7VII1uHDM9lrt7-JDA,27
-pycityagent/brain/persistence/spatial.py,sha256=KShHehHOpvUnqxr12Y1FJF4RgyPjD3QNlWw136-zGR0,549
-pycityagent/brain/reason/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pycityagent/brain/reason/shop.py,sha256=jd0p6MDCNTPxo5j8glopiB501l8AuGP1vFlfDcxX69A,777
-pycityagent/brain/reason/social.py,sha256=6QceFlzrA8FNwKzEvVS2aivSr12rkMbyOFO4mlACCfk,6493
-pycityagent/brain/reason/trip.py,sha256=Slop2IxwZ9KE8ZqMOfYbMAgZ2hUcs4LuesxecoSliPc,1543
-pycityagent/brain/reason/user.py,sha256=m1CQrG_Y-guB0WNeF1pR1HmzyPVrX4qAnuMIRl9-5ig,6412
-pycityagent/brain/retrive/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-pycityagent/brain/retrive/social.py,sha256=EfF_9VCPTnDHBd2c5OmH3L4--07Ctps5HJBpSO3hUAA,135
-pycityagent/cc/__init__.py,sha256=eNYRAjU_IIJY1Nt2vGyt34KQjbrpyZuv_AvY_iuPb6A,123
-pycityagent/cc/cc.py,sha256=b2_Q4dpPO8F1tY-N1m-YFfdzEu_dg8AYsjihvhrWijM,4201
-pycityagent/cc/conve.py,sha256=sRhZleIGeAV2m6mWoevwUMx2wD0xLVF5qnCld6pDC2E,150
-pycityagent/cc/idle.py,sha256=RbqwG4BdSpLdZ-_13mLMbUs20q8r5drKB4wNIGWPOZw,474
-pycityagent/cc/shop.py,sha256=9c8XTcUZBV90N_0MF3Gi9jlUS0LqNR3vIazEkK8tA28,149
-pycityagent/cc/trip.py,sha256=ayTUnED7Kq6qiwEfCO_u-Hz6rRFNzBI25dZGUSV5dJY,312
-pycityagent/cc/user.py,sha256=nS9NFfZypvXf-vLzqnYzLc6ek-CS8WALtEb00s1nREI,285
-pycityagent/hubconnector/__init__.py,sha256=O11GJiILTibDUgJiAZxfIZ0kckKvToPUYijd06RQ0iQ,53
-pycityagent/hubconnector/hubconnector.py,sha256=U8sN9_XX0UVuKaKW57_rmst87XjGlCy79Ar5LQQOnJ4,5259
-pycityagent/image/__init__.py,sha256=OiSQBalg4Uo8bjjLNaUWb_DjSb-Rg8yGfb8Su6Sdvo4,58
-pycityagent/image/image.py,sha256=0efdbmQCGwqPb2WmBcRIjDu0miTSOPEkOGUKyZaDg58,5225
-pycityagent/st/__init__.py,sha256=YzsQXrgqRvmoQ4dWqAztAriKd8wvnQVe0FOpX_oZmiY,109
-pycityagent/st/st.py,sha256=bGisgrBaKEQCUMobRcBqIPh_4N5I0GIVc1mGglSwBO8,3743
-pycityagent/urbanllm/__init__.py,sha256=D24mYFXdIEL2vbvB7Cp_BGgJvg-tvEnCgtEAAGaqGDY,56
-pycityagent/urbanllm/urbanllm.py,sha256=XEmU4fpdxA7zZlSfdXnXd9SIsPF0eC1SjxPKHAjxuAE,4341
-pycityagent-1.0.0.dist-info/LICENSE,sha256=Yo9QmwLDFU3VoOc0W8aYSCa5Yj5sJyqM3FEcbC2jMQQ,1063
-pycityagent-1.0.0.dist-info/METADATA,sha256=jWCBLBIrjSOqPSIouNDA__kUnLfIwRd4JfwXeBgHMKU,6460
-pycityagent-1.0.0.dist-info/WHEEL,sha256=oiQVh_5PnQM0E3gPdiz09WCNmwiHDMaGer_elqB3coM,92
-pycityagent-1.0.0.dist-info/top_level.txt,sha256=mf70CsOn3eVJBwHQ_TjCesoc-elD0Bj2WLsi5APRjlU,12
-pycityagent-1.0.0.dist-info/RECORD,,