Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Cleanup README and repo #206

Merged
merged 5 commits into from
May 27, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ Resources and programs to generate models (URDF, SDF) of the iCub robot.
The models automatically generated by the software and the resources in this repository
are available at https://github.com/robotology/icub-models .

**Note: this repository is meant to streamline the process of producing iCub URDF/SDF models by iCub mantainers. It is not meant to be used directly by users of iCub. For offical info on the kinematic parameters of the iCub, please see [the documentation in iCub's wiki](http://wiki.icub.org/wiki/ICubForwardKinematics).**
**Note: this repository is meant to streamline the process of producing iCub URDF/SDF models by iCub mantainers. It is not meant to be used directly by users of iCub. For offical info on the kinematic parameters of the iCub, please see [the documentation in iCub's documentation](https://icub-tech-iit.github.io/documentation/icub_kinematics/icub-forward-kinematics/icub-forward-kinematics/).**

## Dependencies
- [orocos_kdl](http://www.orocos.org/kdl)
- [iDynTree](https://github.com/robotology/idyntree)
- [YARP](https://github.com/robotology/yarp)
- [simmechanics-to-urdf](https://github.com/robotology/simmechanics-to-urdf)

Detailed documentation on how to install the softare is current work in progress. In the meanwhile, you can check the exact way in which the software is installing by inspecting the [`CI` GitHub Actions workflow](.github/workflows/ci.yml) that is used to automatically generate the models of iCub using this repo and commit it to the [icub-models](https://github.com/robotology/icub-models) repo.

Required only if you wish to generate DH models (`ICUB_MODEL_GENERATE_DH = ON`). Make sure you have compiled iDynTree with the option `IDYNTREE_USES_KDL = ON`.

## Usage
To generate the models, please ensure that you have all the necessary dependencies.
Expand All @@ -21,10 +24,10 @@ Currently, it is possible to generate iCub models by means of two different pipe

1) The generation is achieved by using Denavit Hartenberg parametsrs based on robot-model hardcoded data in the iKin/iDyn source code, and meshes postprocessed by ISIR at UPMC, Paris, available in `dh` directory.

2) The generation is achieved from CAD models converted to simmechanics file, as described in http://wiki.icub.org/wiki/Creo_Mechanism_to_URDF , available in the `simmechanics` directory.
2) The generation is achieved from CAD models converted to simmechanics file, as described in https://github.com/icub-tech-iit/cad-mechanics-public/wiki/Creo-mechanism-to-URDF, available in the `simmechanics` directory.

As the two pipeline process data from different sources, **the link frames are not guaranteed to have the same orientation
or location across different models**. The only frames (that are represented in URDF as massless links) whose position is guaranteed to be consistent across different models are the one documented in http://wiki.icub.org/wiki/ICub_Model_naming_conventions#Frames .
or location across different models**. The only frames (that are represented in URDF as massless links) whose position is guaranteed to be consistent across different models are the one documented in https://icub-tech-iit.github.io/documentation/icub_kinematics/icub-model-naming-conventions/icub-model-naming-conventions/ .

Both generation pipelines are still in `a work in progress` state, and several issues need to be properly solved, e.g.:
* [Meshes are not properly handled #28](https://github.com/robotology/icub-model-generator/issues/28)
Expand Down
38 changes: 0 additions & 38 deletions dh/README.md

This file was deleted.

1 change: 0 additions & 1 deletion dh/generate.sh

This file was deleted.

8 changes: 0 additions & 8 deletions dh/generateCoDyCoSuperbuild.sh

This file was deleted.

13 changes: 0 additions & 13 deletions dh/generated/gazebo_models/database.config

This file was deleted.

Loading