Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (9.2%) to scientific vocabulary
Repository
VehicleSim
Basic Info
- Host: GitHub
- Owner: VAMPIR-Lab
- Language: Julia
- Default Branch: main
- Size: 11.4 MB
Statistics
- Stars: 18
- Watchers: 12
- Forks: 19
- Open Issues: 1
- Releases: 1
Metadata Files
README.md
VehicleSim
VehicleSim
Loading / instantiating code
It is recommended to start julia with multiple threads, since many concurrent tasks will be executing. Important: you must use julia 1.9.3 for all functionality to work properly.
julia +1.9.3 --project --threads=auto
julia
(VehicleSim) pkg> instantiate
(VehicleSim) pkg> add https://github.com/forrestlaine/MeshCat.jl
(VehicleSim) pkg> add https://github.com/forrestlaine/RigidBodyDynamics.jl
You may need to restart Julia at this point before proceeding.
julia
julia> using VehicleSim
Running Simulation
julia
julia> server();
┌ Info: MeshCat server started. You can open the visualizer by visiting the following URL in your browser:
└ http://1.2.3.4:8700
┌ Info: ********************
│ CONNECTING TO SERVER
│ ********************
│ -Connect a keyboard client by running (in a new REPL):
│ using Vehicle Sim, Sockets; keyboard_client(ip"1.2.3.4")
└ -Port for manual clients is 4444
[ Info: Target for vehicle 1: 40
┌ Info: ***************
│ VIEWER COMMANDS
│ ***************
│ -Make sure focus is on this terminal window. Then:
│ -Press 'q' to shutdown server.
│ -Press '0' to switch to bird's-eye view and release controls to user.
│ -Press a number '1'-'9' to view the follow-cam for the associated vehicle. Will default to '0' if vehicle doesn't exist.
└ -Use the 'shift' modifier to follow-cam from top-down (e.g. '!' for vehicle 1).
[ Info: Waiting for client
This will spin up the server / simulation engine. For now, the server will instantiate a single vehicle.
Connecting a keyboard client
In a separate REPL, you can connect to the server with a keyboard client, allowing you to manually drive a vehicle.
julia
julia> using VehicleSim, Sockets # to allow ip strings
julia> keyboard_client(ip"1.2.3.4") # ip address specified by @info statement when starting server
[ Info: Client accepted.
[ Info: Client follow-cam can be connected to at 1.2.3.4:8713
[ Info: Press 'q' at any time to terminate vehicle.
Owner
- Name: VAMPIR Lab
- Login: VAMPIR-Lab
- Kind: organization
- Location: United States of America
- Repositories: 1
- Profile: https://github.com/VAMPIR-Lab
Vanderbilt Mathematical Programming and Intelligent Robotics Lab
Citation (CITATION.CFF)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Laine" given-names: "Forrest" orcid: "https://orcid.org/0000-0003-3982-3920" title: "VehicleSim.jl" version: 0.1.0 date-released: 2023-04-22 url: "https://github.com/Vampir-lab/VehicleSim"
GitHub Events
Total
- Watch event: 4
- Push event: 5
- Fork event: 2
Last Year
- Watch event: 4
- Push event: 5
- Fork event: 2