Skip to content

Commit fe7e811

Browse files
committed
Update README.md
1 parent 1fe2228 commit fe7e811

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ The Python Vehicle Simulator supplements the Matlab MSS (Marine Systems Simulato
2525
shipClarke83.py - Ship, linear maneuvering model specified by L, B and T using the Clarke (1983) formulas
2626
supply.py - Offshore supply vessel controlled by tunnel thrusters and main propellers, L = 76.2 m
2727
tanker.py - Tanker, rudder-controlled ship model including shallow water effects, L = 304.8 m
28-
remus100.py - Cylinder-shaped AUV controlled by a rudder, stern planes and a propeller, L = 1.6 m
28+
remus100.py - Cylinder-shaped AUV controlled by a rudder, stern planes and a propeller, L = 1.6 m
29+
torpedo.py - Cylinder-shaped torpedo controlled by a rudder, stern planes and a propeller, L = 1.6 m
2930
3031
For more information about the mathematical modeling of marine craft and methods for guidance, navigation, and control, please consult:
3132

@@ -39,14 +40,25 @@ To run the main program ```main.py``` the following modules must be installed:
3940
matplotlib https://matplotlib.org/stable/users/installing.html
4041
pytest https://docs.pytest.org
4142

42-
The Python packages are automatically installed by using the command
43+
These dependencies will be automatically installed using the following command:
4344

44-
```pip install <path>```
45+
```pip install -e <path>```
4546

46-
where ```<path>``` is the path of the downloaded PythonVehicleSimulator repository. Example:
47+
where ```<path>``` is the location of the downloaded or cloned PythonVehicleSimulator repository.
4748

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

52-
Note that the -e option is needed to update and change the files. If omitted, you can only run the program.
51+
1. Go to [https://github.com/cybergalactic/PythonVehicleSimulator](https://github.com/cybergalactic/PythonVehicleSimulator)
52+
2. Click the green Code button and choose Download ZIP
53+
3. Extract the ZIP file (you’ll get a folder like PythonVehicleSimulator-main, which you can rename it if desired).
54+
3. Open a terminal and run:
55+
```python3 -m pip install -e /MY_PATH/PythonVehicleSimulator-main``
56+
Replace /MY_PATH/ with the actual path on your system.
57+
58+
**Note:**
59+
The -e option installs the simulator in editable mode, which allows you to modify the source files and immediately see changes. If you omit -e, you can still run the program, but changes to the code won’t take effect until you reinstall the package.
60+
61+
To run tests:
62+
63+
pip install pytest
64+
pytest

0 commit comments

Comments
 (0)