Skip to main content

Simulation tool for prototyping autonomous vehicle related algorithms. Wrapper of the PyChrono simulator.

Project description

WA Vehicle Simulator

The WA Simulator is a powerful, multi-platform, lightweight and user-friendly simulation platform for testing algorithms intended for autonomous robot or vehicle applications. This project is under active development by Wisconsin Autonomous, a student organization at the University of Wisconsin - Madison.

Usage

The WA Simulator is a lightweight tool meant to facilitate algorithm development. As a result, the majority of the actual vehicle dynamics is hidden behind the wa_simulator API. All you need to do is import the module and instantiate the classes.

Default Usage

# Import the wa_simulator
import wa_simulator as wa

def main():
    # Create the system
    sys = wa.WASystem(step_size=1e-3)

    # Create an environment using a premade environment description
    env_filename = wa.WASimpleEnvironment.EGP_ENV_MODEL_FILE
    env = wa.WASimpleEnvironment(sys, env_filename)

    # Create an vehicle using a premade vehicle description
    veh_inputs = wa.WAVehicleInputs()
    veh_filename = wa.WALinearKinematicBicycle.GO_KART_MODEL_FILE
    veh = wa.WALinearKinematicBicycle(sys, veh_inputs, veh_filename)

    # Visualize the simulation using matplotlib
    vis = wa.WAMatplotlibVisualization(sys, veh, veh_inputs, environment=env)

    # Control the vehicle using the arrow keys
    ctr = wa.WAMatplotlibController(sys, veh_inputs, vis)

    # Instantiate the simulation manager
    sim_manager = wa.WASimulationManager(sys, env, veh, vis, ctr)

    # Simulation loop
    step_size = sys.step_size
    while sim_manager.is_ok():
        time = sys.time

        sim_manager.synchronize(time)
        sim_manager.advance(step_size)


if __name__ == "__main__":
    main()

With Chrono

Using Chrono is as simple as changing a few file names and importing the chrono version of the simulator. Even though wa_simulator.chrono is the new import, all default wa_simulator classes are still accessible as seen above. Background about Chrono can be found here.

# Import the wa_simulator
import wa_simulator.chrono as wa

def main():
    # Create the system
    sys = wa.WAChronoSystem(step_size=1e-3)

    # Create an environment using a premade environment description
    env_filename = wa.WAChronoEnvironment.EGP_ENV_MODEL_FILE
    env = wa.WAChronoEnvironment(sys, env_filename)

    # Create an vehicle using a premade vehicle description
    veh_inputs = wa.WAVehicleInputs()
    veh_filename = wa.WAChronoVehicle.GO_KART_MODEL_FILE
    veh = wa.WAChronoVehicle(sys, veh_inputs, env, veh_filename)

    # Visualize the simulation using matplotlib
    vis = wa.WAMatplotlibVisualization(sys, veh, veh_inputs, environment=env)

    # Control the vehicle using the arrow keys
    ctr = wa.WAMatplotlibController(sys, veh_inputs, vis)

    # Instantiate the simulation manager
    sim_manager = wa.WASimulationManager(sys, env, veh, vis, ctr)

    # Simulation loop
    step_size = sys.step_size
    while sim_manager.is_ok():
        time = sys.time

        sim_manager.synchronize(time)
        sim_manager.advance(step_size)


if __name__ == "__main__":
    main()

Command Line Interface

wa_simulator can also be run via a command line interface with the entrypoint wasim. When wa_simulator is installed, this CLI is automatically made available and has subcommands available.

Documentation

License

wa_simulator is made available under the BSD-3 License. For more details, see LICENSE.

Support

Contact Aaron Young for any questions or concerns regarding the contents of this repository.

See Also

Stay up to date with our technical info by following our blog.

Follow us on Facebook, Instagram, and LinkedIn!


Wisconsin Autonomous Logo University of Wisconsin - Madison Crest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wa_simulator-2.2.5.tar.gz (59.5 MB view details)

Uploaded Source

Built Distribution

wa_simulator-2.2.5-py3-none-any.whl (76.9 kB view details)

Uploaded Python 3

File details

Details for the file wa_simulator-2.2.5.tar.gz.

File metadata

  • Download URL: wa_simulator-2.2.5.tar.gz
  • Upload date:
  • Size: 59.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for wa_simulator-2.2.5.tar.gz
Algorithm Hash digest
SHA256 065006048d9761af870546d95e3b456aadd4950b45990746b3f2bc752b745b43
MD5 47b0c24b3c07ea8df60e5f225d2ec4a2
BLAKE2b-256 081457f2018baea4b1002ee88ba03af4e0b7f44a011e45e5e523b30d16d201ab

See more details on using hashes here.

File details

Details for the file wa_simulator-2.2.5-py3-none-any.whl.

File metadata

  • Download URL: wa_simulator-2.2.5-py3-none-any.whl
  • Upload date:
  • Size: 76.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.0 importlib_metadata/4.8.2 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.0

File hashes

Hashes for wa_simulator-2.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 8940e5a78446d7e6b10aa849e6fb24181ce77899b49136aee6a59ba3f5cdfa7f
MD5 37a4f0dc4f2267be1d9d32996d8ceaa7
BLAKE2b-256 0626b0a59519f478445dc0cc77bf41c6159730aa76e085c988c51af82ea84888

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page