Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
cadop committed Jan 20, 2023
1 parent f9d10e1 commit 78516b5
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 11 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@

![preview](https://user-images.githubusercontent.com/11399119/190271233-35524930-1cb8-44c7-b09f-88d4407fe74b.png)

To use:
A crowd simulator API with a default demo scene. The main python API can be used in a few ways. There is an examples folder showing a few use-cases. Users can also switch between social forces and PAM as the crowds algorithm.

- Load Extension
- Enter desired number of agents (should be a square number)
- Create two Xforms or prims in the World stage with names "Goal1" and "Goal2"
- Run the "Play" button to see simulation
The extension will load an populate some demo configuration. It will create an Xform called CrowdGoals. To add a goal for the crowd. Create an xform under the "CrowdGoals". We automatically check for those prims as the method of determing crowd goals. For every additional xform under CrowdGoals, we evenly split the crowd to assign those goals.

There are two options for the crowd objects. The default uses geompoints, which is faster and runs its own integration of the forces for position and velocity. It does not interact with any physics in the scene. Alternatively the "Rigid Body" can be used, which creates physical spheres that interact with the scene.

Press Play to see the crowd.

The default number of demo agents is a 3x3 grid (9 agents). The current simulator in python may struggle above 25 agents, depending on CPU configuration.

We plan to support more methods in the future, as well as more crowd simulators. Contributions are welcome.
15 changes: 9 additions & 6 deletions exts/siborg.simulate.crowd/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,13 @@
# Crowd Simulator

An implementation of the Social Forces crowd simulation (it may or may not be correct). There is currently no environment detection. The current implementation is in PhysX. We plan to support more methods in the future, as well as more crowd simulators. Contributions are welcome.
A crowd simulator API with a default demo scene. The main python API can be used in a few ways. There is an examples folder showing a few use-cases. Users can also switch between social forces and PAM as the crowds algorithm.

To use:
The extension will load an populate some demo configuration. It will create an Xform called CrowdGoals. To add a goal for the crowd. Create an xform under the "CrowdGoals". We automatically check for those prims as the method of determing crowd goals. For every additional xform under CrowdGoals, we evenly split the crowd to assign those goals.

- Load Extension
- Enter desired number of agents (should be a square number)
- Create two Xforms or prims in the World stage with names "Goal1" and "Goal2"
- Run the "Play" button to see simulation
There are two options for the crowd objects. The default uses geompoints, which is faster and runs its own integration of the forces for position and velocity. It does not interact with any physics in the scene. Alternatively the "Rigid Body" can be used, which creates physical spheres that interact with the scene.

Press Play to see the crowd.

The default number of demo agents is a 3x3 grid (9 agents). The current simulator in python may struggle above 25 agents, depending on CPU configuration.

We plan to support more methods in the future, as well as more crowd simulators. Contributions are welcome.

0 comments on commit 78516b5

Please sign in to comment.