| Both sides previous revisionPrevious revisionNext revision | Previous revision | 
| doc [2022/02/17 13:29]  – [Frequently Asked Questions]  gkazhoya | doc [2022/04/19 14:48] (current)  –  gkazhoya | 
|---|
| ====== CRAM documentation ====== | ====== CRAM documentation ====== | 
| ~~NOTOC~~ |   | 
 |  | 
| ===== Getting started ===== |   | 
 |  | 
|   * [[doc/getting_started|Getting started]]  | ===== Getting started =====  | 
|   * [[doc/guidelines|CRAM Programming Guidelines]]  |    | 
|   * [[doc/testing|Utilities for testing CRAM packages]] |   * [[installation|CRAM installation instructions]]  | 
|   |   * [[/doc/ide|Setup and IDE]] describes the recommended IDE and how to set it up  | 
|   |   * [[/doc/getting_started/lisp_crash_course|Very quick crash course in Lisp]]  | 
|   |   * [[/tutorials|Tutorials]] to acquire hands-on experience with CRAM  | 
|   |   * [[/doc/links|Links]] to broaden your background knowledge on Lisp, Robotics, AI, Planning  | 
|   |   * [[/doc/guidelines|Programming Guidelines]]: skim through before starting to write your own CRAM code  | 
|   |   * [[doc/testing|Guidelines for test-driven development]] | 
 |  | 
 |  | 
| ===== Frequently Asked Questions ===== | ===== Frequently Asked Questions ===== | 
 |  | 
| <html><!--  * [[doc/faq| CRAM FAQ]] --></html> |   | 
|   * [[https://answers.ros.org/questions/scope:all/sort:activity-desc/page:1/query:cram/|Questions on answers.ros.org]] |   * [[https://answers.ros.org/questions/scope:all/sort:activity-desc/page:1/query:cram/|Questions on answers.ros.org]] | 
|   * [[http://cram-system.org/doc/package/why_lisp|Why Lisp?]] |   * [[http://cram-system.org/doc/package/why_lisp|Why Lisp?]] | 
|   * [[doc/faq| CRAM FAQ]] |   * [[doc/faq| CRAM FAQ]] | 
|   |  | 
|   |  | 
|   | ===== Publications ===== | 
|   |  | 
|   | See the [[research|Research]] page. | 
 |  | 
 |  | 
| ===== Functionality Documentation ===== | ===== Functionality Documentation ===== | 
|   |  | 
|   * [[doc/reasoning/overview|Geometric reasoning with bullet]] |   * [[doc/reasoning/overview|Geometric reasoning with bullet]] | 
|   * [[doc/cpl|CRAM Plan Language (CPL) concepts]] |   * [[doc/cpl|CRAM Plan Language (CPL) concepts]] | 
 |  | 
| ===== Theses ===== |   | 
|   * [[https://mediatum.ub.tum.de/doc/1239461/1239461.pdf|Lorenz Mösenlechner PhD Thesis]] with a comprehensive overview of CRAM v1 components (thesis overview can be found [[lorenz-thesis-overview|here]]) |   | 
|   * {{::tcr_bachelor_thesis.pdf |Tobias Christian Rittweiler Bachelor thesis}} on CRAM language |   | 
|   * {{ ::andreas_romero_frueh_bsc.pdf | Andreas Romero Frueh's Bachelor's thesis}} on using the CRAM bullet world for validating perception results |   | 
|   * {{ ::arthur_niedzwiecki_bsc.pdf | Arthur Niedzwiecki's Bachelor's thesis}} on CRAM plan transformations |   | 
|   * {{ ::alina_hawkin_bsc.pdf | Alina Hawkin's Bachelor's thesis}} and {{ ::alina_hawkin_msc.pdf |Master' thesis}} on using data collected by humans acting in VR for parametrizing robot actions |   | 
|   * {{ ::vanessa_hassouna_bsc.pdf | Vanessa H.'s Bachelor's thesis}} on cutting and pouring action plans for Bullet simulation |   | 
|   * {{ ::thomas_lipps_bsc.pdf | Thomas Lipps's Bachelor's thesis}} on learning location costmaps from data of humans acting in VR |   | 
|   * {{ ::arthur_niedzwiecki_msc.pdf | Arthur Niedzwiecki's Master's thesis}} on integrating tactile events into CRAM plans for real-world assembly tasks |   | 
 |  | 
|   | ===== Autogenerated API ===== | 
 |  | 
| ===== API =====  |   * [[doc/api/cram-language|cram-language aka CPL]] | 
|   * [[doc/api/cram-language|Autogenerated API for cram-language]] |  | 
 |  | 
 |  | 
| ===== ROS Package Documentation ===== | ===== ROS Package Documentation ===== | 
|   |  | 
| **This section is outdated, so some code might not run. See the Tutorials page for more up to date code.** | **This section is outdated, so some code might not run. See the Tutorials page for more up to date code.** | 
 |  | 
|   * [[doc/package/cram_designators|cram_designators]] |   * [[doc/package/cram_designators|cram_designators]] | 
|   * [[doc/package/cram_process_modules|cram_process_modules]] |   * [[doc/package/cram_process_modules|cram_process_modules]] | 
 |   | 
| ===== PyCRAM =====  |   | 
| This section contains the documentation for the Python implementation of CRAM called PyCRAM. |   | 
|     * [[doc/pycram/bulletWorld|Bullet World]] |   | 
|     * [[doc/pycram/reasoning|Bullet World Reasoning]] |   | 
|     * [[doc/pycram/designator|Designator]] |   | 
|     * [[doc/pycram/implemented_desigs|Implemented Desigantor]] |   | 
|     * [[doc/pycram/process_modules|Process Modules]] |   | 
|     * [[doc/pycram/ik|Inverse Kinematics]] |   | 
|     * [[doc/pycram/language|PyCRAM Plan Language]] |   | 
|     * [[doc/pycram/fluents|Fluents]] |   | 
|     * [[doc/pycram/robot_description|Robot Description]] |   | 
 |   | 
|   * {{ ::augstens_bsc.pdf | Augsten brother's Bachelor's thesis}} on PyCRAM language |   | 
|   * {{ ::jonas_dech_bsc.pdf | Jonas Dech's Bachelor's thesis}} on PyCRAM Bullet World |   | 
|   * {{ ::chrsitopher_pollok_msc.pdf | Christopher Pollok's Master's thesis}} on task trees and action designators in PyCRAM |   | 
 |  | 
 |  |