| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| doc [2022/03/31 07:23] – [Deprecated documentation] sasjonge | doc [2024/09/10 11:50] (current) – [Tutorials] daniel86 |
|---|
| ====== KnowRob documentation ====== | ====== KnowRob documentation ====== |
| |
| //**NOTE** We are currently working on migrating some of the tutorials marked as deprected to the current master branch KnowRob. The main reason they are deprecated is that the KnowRob code has migrated to the foundational ontology [[https://github.com/ease-crc/dul|DUL]]. In addition, many activity-related concepts are now defined in the [[https://github.com/ease-crc/soma|SOMA]] ontology, and have been deleted from **knowrob.owl** (which is now restricted to robot-related concepts). There were many good reasons to do this breaking change such as better organization of ontologies according to generality of concepts, the ending of free Cyc, better compatibility to other knowledge-based systems, and many more.// | A detailed documentation is available in the [[https://github.com/knowrob/knowrob|github repository]]. |
| | Please have a look at the README.md files there. In addition, a broad overview is provided |
| ===== Getting started ===== | by the following pages: |
| |
| * [[doc/getting_started|Getting started]] | * [[doc/getting_started|Getting started]] |
| * [[doc/knowrob_basics|KnowRob basics]] | |
| * [[doc/important_concepts|Important concepts]] | * [[doc/important_concepts|Important concepts]] |
| * [[doc/best-practices|Best practices]] | * [[doc/best-practices|Best practices]] |
| | |
| | ====== Tutorials ====== |
| | |
| | Tutorials are available in form of //jupyter// notebooks. |
| | They are part of the source tree and can be found in the [[https://github.com/knowrob/knowrob/tree/dev/jupyter|/jupyter]] |
| | directory. |
| | |
| | A local binder instance might be available [[https://binder.intel4coro.de/v2/gh/knowrob/knowrob.git/dev?labpath=jupyter%2Fintro.ipynb|here]] to run the tutorials in the browser. |
| ===== Frequently Asked Questions ===== | ===== Frequently Asked Questions ===== |
| |
| |
| ===== Deprecated documentation ===== | ===== Deprecated documentation ===== |
| Deprecated documentation can be found [[doc_deprecated|here]]. | **Deprecated** documentation can be found [[doc_deprecated|here]]. They will not work with the current version of KnowRob. |
| ==== Tutorials ==== | |
| * [[doc/loading_files_and_ros_packages|Loading files and ROS packages]] | |
| * [[doc/reasoning_about_objects|Reasoning about objects]] | |
| * [[doc/reasoning_about_actions|Reasoning about actions]] | |
| * [[doc/create_your_own_knowrob_package|Create your own KnowRob package]] | |
| * [[doc/create_and_load_a_semantic_map|Create and load a semantic map]] | |
| * [[doc/interact_with_knowrob_via_ros|Use KnowRob from your program]] | |
| * [[doc/reasoning_using_computables|Reasoning using computables]] | |
| * [[doc/defining_computables|Define computables]] | |
| * [[doc/writing_an_interface_to_your_perception_system|Write an interface to your perception system]] | |
| * [[doc/srdl2_tutorial|Reason about the robot's hardware and capabilities (SRDL)]] | |
| * [[doc/create_srdl_model|Create a model of your robot in the Semantic Robot Description Language (SRDL)]] | |
| * [[doc/common-sense_reasoning_about_object_locations|Common-sense reasoning about object locations]] | |
| | |
| ==== KnowRob infrastructure ==== | |
| * [[/doc/catkin_migration|Migration guide]] to the catkinized version of KnowRob | |
| * [[/doc/pldoc_code_documentation|Source code documentation with pldoc]] | |
| * [[doc/plunit_testing|Unit testing with plunit]] | |
| * Cloud-based KnowRob-as-a-Service applications | |
| * [[/doc/docker|Install and run own openEASE instance]] | |
| * [[/doc/docker/dev|KnowRob & Docker developers guide]] | |
| * [[/doc/docker/add-dataset|Add your own dataset]] | |
| | |
| * Integration of [[OWL reasoners via OWLAPI]] | |
| | |
| ==== Representing objects, the environment and other spatial information ==== | |
| * KnowRob's spatio-temporal [[doc/object_pose_representation|object pose representation]] | |
| * Representing and converting [[doc/measurement_units|measurement units]] | |
| * Representing and converting [[doc/coordinate_systems|coordinate systems]] | |
| * Representing [[doc/environment_map_meta_information|Environment map meta information]] | |
| |
| ==== Representing and reasoning about actions ==== | |
| * [[doc/modeling_tasks_and_actions|Modeling tasks and actions]] | |
| * [[doc/modeling_changing_objects|Modeling changing objects]] and the effects of actions on objects | |
| * [[doc/reasoning_about_logged_experiences|Reasoning about logged robot experiences]] | |
| * [[doc/motion_constraints|Modeling and generating constraint-based movement descriptions]] | |
| |
| ==== Visualization tools and editors ==== | |
| * [[doc/web_visualization|Web-based 3D visualization canvas]] | |
| * [[doc/web_visualization/architecture|System architecture]] | |
| * [[doc/marker_visualization|3D object visualization]] | |
| * [[doc/chart_visualization|Visualization of charts and diagrams]] | |
| |
| * Analysis and segmentation of [[doc/mesh_reasoning|3D object models]] | |
| |
| * [[doc/semantic_map_editor|Semantic map editor]] | |
| * [[doc/action_recipe_editor|Action recipe editor]] | |
| * [[doc/labeling_tools|Labeling tools]] for annotating observations of human activities | |
| |
