Skip to content

Commit 88b50a9

Browse files
committed
2 parents 7bf307e + ecf6a2f commit 88b50a9

File tree

1 file changed

+7
-9
lines changed

1 file changed

+7
-9
lines changed

README.md

+7-9
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
# Python Vehicle Simulator
22

3-
The Python Vehicle Simulator is a supplement to the Matlab MSS (Marine Systems Simulator) toolbox. It includes models for autonomous underwater vehicles (AUVs), unmanned surface vehicles (USVs), and ships. The vehicle models are based on the MSS vessel models located in /MSS/VESSELS/ catalogue. Each vehicle is modeled as an object in Python and the vehicle class has methods for guidance, navigation and control. The main program ```main.py``` is used to define vehicle objects for real-time simulation.
4-
5-
URL: https://www.fossen.biz/wiley/pythonVehicleSim.php
3+
The Python Vehicle Simulator supplements the Matlab MSS (Marine Systems Simulator) toolbox. It includes models for autonomous underwater vehicles (AUVs), unmanned surface vehicles (USVs), and ships. The vehicle models are based on the MSS vessel models in /MSS/VESSELS/catalog. Each vehicle is modeled as an object in Python, and the vehicle class has methods for guidance, navigation, and control. The main program ```main.py``` defines vehicle objects for real-time simulation.
64

75
Root folder:
86
/src/python_vehicle_simulator/
97
main.py - MAIN PROGRAM (terminal command >>python3 main.py)
10-
3D_animation.gif - 3D animation file which can be opened in a web browser by right-clicking the file
8+
3D_animation.gif - 3D animation file that can be opened in a web browser by right-clicking the file
119
1210
Library files:
1311
/src/python_vehicle_simulator/lib/
@@ -29,25 +27,25 @@ URL: https://www.fossen.biz/wiley/pythonVehicleSim.php
2927
tanker.py - Tanker, rudder-controlled ship model including shallow water effects, L = 304.8 m
3028
remus100.py - Cylinder-shaped AUV controlled by a rudder, stern planes and a propeller, L = 1.6 m
3129
32-
For more information about mathematical modeling of marine craft and methods for guidance, navigation and control, please consult:
30+
For more information about the mathematical modeling of marine craft and methods for guidance, navigation, and control, please consult:
3331

3432
T. I. Fossen (2021). Handbook of Marine Craft Hydrodynamics and Motion Control. 2nd. Edition, Wiley.
35-
URL: www.fossen.biz/wiley
33+
URL: https://wiley.fossen.biz
3634

3735
## Install:
38-
In order to run the main program ```main.py``` the following modules must be installed:
36+
To run the main program ```main.py``` the following modules must be installed:
3937

4038
numpy https://numpy.org/install/
4139
matplotlib https://matplotlib.org/stable/users/installing.html
4240
pytest https://docs.pytest.org
4341

44-
The Python packages are automatically installed by uisng the command
42+
The Python packages are automatically installed by using the command
4543

4644
```pip install <path>```
4745

4846
where ```<path>``` is the path of the downloaded PythonVehicleSimulator repository. Example:
4947

50-
1. Click on the green code tab on Github and choose download
48+
1. Click on the green code tab on GitHub and choose download
5149
2. This gives you the catalog: PythonVehicleSimulator-master (can be renamed)
5250
3. ```python3 -m pip install -e /MY_PATH/PythonVehicleSimulator-master```
5351

0 commit comments

Comments
 (0)