diff --git a/Documentation/Issues.md b/Documentation/Issues.md new file mode 100644 index 00000000..db5baf46 --- /dev/null +++ b/Documentation/Issues.md @@ -0,0 +1,46 @@ + +# Issues + +
+
+ +## Exception `GeographicLib::GeographicErr` + +*when starting `uwsim`.* + +
+ +### Showcase + +*You should be getting the following error*
+*when executing `rosrun uwsim uwsim` :* + +```txt +... +data/objects/gun.osg +Starting UWSim... +Loading SimulatedDevices plugin: 'AcousticCommsDevice_Factory' +Loading SimulatedDevices plugin: 'CustomCommsDevice_Factory' +Loading SimulatedDevices plugin: 'DredgeTool_Factory' +Loading SimulatedDevices plugin: 'ForceSensor_Factory' +Loading SimulatedDevices plugin: 'SimDev_Echo_Factory' +. Setting localized world: 7.1e-05s +terminate called after throwing an instance of 'GeographicLib::GeographicErr' +what(): File not readable /usr/share/GeographicLib/geoids/egm96-5.pgm +/opt/ros/melodic/lib/uwsim/uwsim: line 23: 1452 Aborted +(core dumped) rosrun uwsim uwsim_binary --dataPath ~/.uwsim/data $@ +``` + +
+ +### Fix + +*Run the following command:* + +```sh +wget https://raw.githubusercontent.com/mavlink/mavros/master/mavros/scripts/install_geographiclib_datasets.sh +chmod u+x install_geographiclib_datasets.sh +sudo ./install_geographiclib_datasets.sh +``` + +
\ No newline at end of file diff --git a/README.md b/README.md index cfb471a1..58122e03 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,101 @@ -# UWSim-NET: UWSim with Network Simulator -[![Build Status](http://build.ros.org/job/Mbin_uB64__uwsim__ubuntu_bionic_amd64__binary/badge/icon)](http://build.ros.org/job/Mbin_uB64__uwsim__ubuntu_bionic_amd64__binary/) - -The new version of UWSim intregates a Network Simulator to be used along with the dccomms API. This simulator uses the NS3 libraries and the AquaSimNG as a NS3 module. The documentation related to simulate communications is a work in progress and will be included in the Wiki as soon as we can (please, be patience). - -### Wiki -http://www.irs.uji.es/uwsim/wiki/index.php?title=Main_Page - -### Citations -- Prats, M.; Perez, J.; Fernandez, J.J.; Sanz, P.J., "An open source tool for simulation and supervision of underwater intervention missions", 2012 IEEE/RSJ International Conference on Intelligent Robots and Systems (IROS), pp. 2577-2582, 7-12 Oct. 2012 -- Centelles, D.; Soriano-Asensi, A.; Martí, J.V.; Marín, R.; Sanz, P.J. Underwater Wireless Communications for Cooperative Robotics with UWSim-NET. Appl. Sci. 2019, 9, 3526. - -### Issues - -#### Exception GeographicLib::GeographicErr when starting uwsim - -If you are getting the following error output when executing rosrun uwsim uwsim: -``` - ... - data/objects/gun.osg - Starting UWSim... - Loading SimulatedDevices plugin: 'AcousticCommsDevice_Factory' - Loading SimulatedDevices plugin: 'CustomCommsDevice_Factory' - Loading SimulatedDevices plugin: 'DredgeTool_Factory' - Loading SimulatedDevices plugin: 'ForceSensor_Factory' - Loading SimulatedDevices plugin: 'SimDev_Echo_Factory' - . Setting localized world: 7.1e-05s - terminate called after throwing an instance of 'GeographicLib::GeographicErr' - what(): File not readable /usr/share/GeographicLib/geoids/egm96-5.pgm - /opt/ros/melodic/lib/uwsim/uwsim: line 23: 1452 Aborted (core dumped) rosrun uwsim uwsim_binary --dataPath ~/.uwsim/data $@ -``` - -Run the following commands to fix it: -``` - wget https://raw.githubusercontent.com/mavlink/mavros/master/mavros/scripts/install_geographiclib_datasets.sh - chmod u+x install_geographiclib_datasets.sh - sudo ./install_geographiclib_datasets.sh -``` +# UWSim - NET   [![Badge Build]][Status] +*UWSim + Network Simulator* +
+ +
+ +The new version of **UWSim** integrates
+a **Network Simulator** to be used
+along with the **dccomms** API. + +
+ +--- + +[ 
 Wiki 
 ][Wiki]    +[ 
 Issues 
 ][Issues] + +--- + +
+ +
+ +## Libraries + +- **NS3 Libraries** + +- **[AquaSimNG]** + +
+ +## Documentation + +*The documentation related to simulating communication is*
+*work in progress and will be included in the **[Wiki]** as soon*
+*as we can, please be patience.* + +
+ +## Citations + +
+ +-  [Prats, M.]   +  [Perez, J.]   +  [Fernandez, J.J.]   +  [Sanz, P.J.]  + + [' An open source tool for simulation and supervision of underwater intervention missions '][Article Tool] + +  2012 IEEE / RSJ  International Conference on Intelligent Robots and Systems (IROS)  + +  Pages 2577 - 2582   +  Conference 7 - 12 Oct. 2012  + +
+ +-  [Centelles, D.]   +  [Soriano-Asensi, A.]   +  [Martí, J.V.]   +  [Marín, R.]   +  [Sanz, P.J.]  + + [' Underwater Wireless Communications for Cooperative Robotics with UWSim-NET '][Article Communication] + +  Applied Sciences 2019   +  Volume 9   +  Article 3526  + +
+ + + + +[Badge Build]: http://build.ros.org/job/Mbin_uB64__uwsim__ubuntu_bionic_amd64__binary/badge/icon + +[AquaSimNG]: https://github.com/rmartin5/aqua-sim-ng +[Status]: http://build.ros.org/job/Mbin_uB64__uwsim__ubuntu_bionic_amd64__binary/ +[Issues]: Documentation/Issues.md +[Wiki]: http://www.irs.uji.es/uwsim/wiki/index.php?title=Main_Page + + + + +[Prats, M.]: https://ieeexplore.ieee.org/author/37420647500 +[Perez, J.]: https://ieeexplore.ieee.org/author/38540825400 +[Fernandez, J.J.]: https://ieeexplore.ieee.org/author/37278905400 + +[Soriano-Asensi, A.]: https://orcid.org/0000-0002-4662-8747 +[Centelles, D.]: https://orcid.org/0000-0002-3743-1475 +[Martí, J.V.]: https://orcid.org/0000-0001-9922-5733 +[Sanz, P.J.]: https://orcid.org/0000-0003-3382-1553 +[Marín, R.]: https://orcid.org/0000-0002-2340-4126 + + + +[Article Communication]: https://www.mdpi.com/2076-3417/9/17/3526 +[Article Tool]: https://ieeexplore.ieee.org/document/6385788