# symoro

**Repository Path**: raysworld/symoro

## Basic Information

- **Project Name**: symoro
- **Description**: OpenSYMORO, an open source software package for symbolic modelling of robots.
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://ieeexplore.ieee.org/document/6878246
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-08-23
- **Last Updated**: 2024-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

SYMORO
======

SYOMRO is a software package for SYmbolic MOdeling of RObots.

This software package is developed as part of the OpenSYMORO project by
the robotics team at [IRCCyN][lk:irccyn] under the supervision of Wisama
Khalil.

For details on the algorithms used, please see [the paper][lk:hal]
published in the AIM 2014 conference.


How to Use (2023)
------------
Since many of the dependencies are not too old and not easy to configure any more, 
we recommend to use it via a docker container. Currently this is only tested on 
a Ubuntu machine.
- Install [Docker](https://docs.docker.com/engine/install/ubuntu/)
- Pull the docker image from Docker Hub:
  ```bash
  docker pull raysworld/symoro:v1
  ```
- Run the docker by executing the shell script:
  ```bash
  bash symoro_start.sh
  ``` 

Development
------------
If you would like to change anything inside the docker, you may check the `Dockerfile.symoro`
in `docker` folder and then rebuild the docker image via the following command:
```bash
docker build -f Dockerfile.symoro -t raysworld/dymoro:<tag> .
```
Change `<tag>` to any string e.g. `v2`.


References
------------
1. https://www.cnblogs.com/azureology/p/16590885.html
2. https://blog.csdn.net/xiaofeng_yan/article/details/5923906
3. https://stackoverflow.com/questions/8179139/failed-to-compile-wxwidgets-2-9-2-on-kubuntu11-1064bit-with-with-opengl-fl
4. https://github.com/wxWidgets/wxWidgets/issues/13375

Requirements
------------
+ python (>= 2.7, &nbsp;&nbsp; 3.* is not supported)
+ sympy (== 0.7.3)
+ numpy (>= 1.6.1)
+ wxPython (>= 2.8.12)
+ PyOpenGL (>= 3.0.1b2)


Getting Started
---------------
+ For setting up SYMORO, see [Setup][lk:setup].
+ If you have any queries, contact [Aravind][el:aravind].


Licence
-------
See [LICENCE][lk:licence].


Contributors
------------
See [Contributors][lk:contributors].


[lk:irccyn]: http://www.irccyn.ec-nantes.fr/
[lk:hal]: http://hal.archives-ouvertes.fr/hal-01025919
[lk:setup]: https://github.com/symoro/symoro/wiki/Setup
[el:aravind]: mailto:aravind.v@tum-create.edu.sg
[lk:licence]: https://github.com/symoro/symoro/blob/master/LICENCE
[lk:contributors]: https://github.com/symoro/symoro/graphs/contributors