Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
corentinlger committed Jul 17, 2024
1 parent 56659c7 commit c66b3b1
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# SimulationSandbox

Minimalistic simulation environment implemented in Jax with simple server-client interaction. Enables modifying the simulation state in real time from notebook controllers, and plotting the state on distant clients.
SimulationSandbox is a simple framework built with Jax and Socket that allows for real-time interaction between a simulation hosted on a server and multiple clients. It provides a simple interface fmodifying or plotting the state of a hosted simulation from remote clients such as jupyter notebooks.

## Install

Expand Down Expand Up @@ -65,7 +65,5 @@ And add your own features to the [tests directory](tests/)

## TODO :

- Add a networking class for client-server interaction
- Stop the atrocious popping up of matplotlib interactive figures
- Replace sending the first example state with pickle by generating it on the client side
- Further check the interaction between 3D sim and notebook client
- Stop the popping up of matplotlib interactive figures
- Replace the mechanism to send the first example state to the client (currently using pickle)

0 comments on commit c66b3b1

Please sign in to comment.