| Both sides previous revision Previous revision Next revision | Previous revision |
| documentation [2017/07/05 16:06] – [Developers' Corner] gawrilow | documentation [2019/06/07 13:10] (current) – benmuell |
|---|
| ====== Documentation of polymake ====== | ====== Reference Documentation ===== |
| ===== How to use polymake ===== | |
| Basic usage and comprehensive descriptions. | |
| * [[tutorial:start|Tutorials]], both for beginners and more advanced users | |
| * [[general|The polymake interactive shell]] | |
| * Demonstration of features of the new [[news/release_3_1|release 3.1]] | |
| * Technical [[howto:start|HowTos]] for specific tasks | |
| * A bit of [[howto:lingo|polymake lingo]]: What is an "application"? What is a "big"/"small" object? ... | |
| ==== Reference Documentation ==== | |
| |
| * [[release_docs:latest|Latest release]]: mathematical objects, properties, methods, etc.\\ Direct access to applications: [[reldocs>latest/polytope.html|polytope]], [[reldocs>latest/fan.html|fan]], [[reldocs>latest/tropical.html|tropical]], ... | * [[reldocs>latest|Latest release]]: mathematical objects, properties, methods, etc.\\ Direct access to applications: [[reldocs>latest/polytope.html|polytope]], [[reldocs>latest/fan.html|fan]], [[reldocs>latest/tropical.html|tropical]], ... |
| * [[reldocs>snapshot|Latest snapshot]]: reference documentation of the latest [[perpetualbeta|perpetual beta]].\\ Direct access to applications: [[reldocs>snapshot/polytope.html|polytope]], [[reldocs>snapshot/fan.html|fan]], [[reldocs>snapshot/tropical.html|tropical]], ... | * [[reldocs>master|Latest master]]: reference documentation of the latest master branch.\\ Direct access to applications: [[reldocs>master/polytope.html|polytope]], [[reldocs>master/fan.html|fan]], [[reldocs>master/tropical.html|tropical]], ... |
| |
| |
| ==== Advanced Users ==== | |
| |
| Learning how to extend ''polymake''. | |
| * [[scripting:start|Scripting]] for "power users" | |
| * [[reference::clients|Writing C++ clients]] | |
| * [[reference::callable|Using Callable Library]] (from release 2.10 on) | |
| * [[reference:rulefiles|Writing rule files]] | |
| * [[reference:extensions|Writing and using extensions]] | |
| |
| Details on selected topics, also linked from general pages above. | |
| * [[reference:rules|Production rules]] | |
| * [[reference:help_formatting|Formatting help blocks]] | |
| * [[reference:permutations|Permutations]] | |
| * [[reference:polymorphic|Polymorphic functions]] | |
| * [[reference:cpp_type_binding|Property type binding to C++ classes]] | |
| ==== Additional Material ==== | |
| |
| * [[Publications]]: a list of papers with a reference to polymake. This way you can learn how other people are using the system. | |
| * [[data|Data base]] of objects available in polymake-format. Contributions are welcome. | |
| * [[Extensions]]: things programmed in polymake by other people. Stay tuned. | |
| * [[Interfaces]]: other software packages calling polymake. | |
| ===== Developers' Corner ===== | |
| |
| Beware: The information below may be entirely unrelated to any official release. For the documentation of the current release see the above on this page. | |
| |
| * [[devel:start|Internals]]: (partially obsolete) introduction for developers | |
| * [[devel:design_decisions|Design decisions]] | |
| * [[reldocs>master|Documentation of the current developer version]] | |
| * Still incomplete documentation of the [[reldocs>master/PTL|Polymake Template Library]]: C++ classes for "small" objects. | |
| * [[devel:git|polymake git guide]]: Introduction to git for polymake | |
| * [[devel:tests|tests]]: How to test PTL data structures | |
| * [[devel:Java Part of Visualization]] | |