====== polymake User Guide ======
Welcome to the user guide! Here you will find tutorials for various computation tasks as well as technical information about polymake's inner workings.


===== First Steps =====

   * [[intro_tutorial|Introduction Tutorial]]: Please read this first.
   * Further general information about how polymake works
      * [[.tutorials:perl_intro|Using Perl within polymake]]
      * [[shell|The polymake interactive shell]]
      * [[.tutorials:properties|Objects and Properties]]
    * If you plan on writing an **polymake extension**, you can find a user guide [[.extend:extensions|here]].

===== Tutorials =====
==== Application Tutorials ====
These are introductory tutorials for the applications on the different mathematical topics you can use ''polymake'' for.
  * [[.tutorials:apps_fan|fan]] for fans
  * [[.tutorials:apps_fulton|fulton]] for toric varieties
  * [[.tutorials:apps_graph|graph]] for graphs
  * [[.tutorials:apps_group|group]] for groups and their actions on polymake objects
  * [[.tutorials:apps_matroid|matroid]] for matroids
  * [[.tutorials:apps_polytope|polytope]] for polyhedra
  * [[.tutorials:apps_topaz|topaz]] for topology
  * [[.tutorials:apps_tropical|tropical]] for tropical geometry

==== More Specific Computations ====
=== Geometry of polyhedra ===
   *  [[.tutorials:coordinates|Coordinates for Polyhedra]] 
   *  [[.tutorials:polytope_semantics|Polytope Semantics]]
   *  [[.tutorials:transformations|Polytopes and Linear Maps]]

=== Optimization ===
   *  [[.tutorials:optimization|polymake and Optimization]] by Sebastian Pokutta and Marc E. Pfetsch
   *  Integer Linear Programming tutorials:
      * [[.tutorials:ilp_and_hilbertbases|ILP and Hilbert bases]]
      * [[.tutorials:matching_polytopes|Matching polytopes]]
      * [[.tutorials:caratheodory|A Counter-example to an integer analogue to Caratheodory's Theorem]]
      * [[.tutorials:polymakeilp|Convex hulls and Lattice Points]]
=== Visualization ===
   *  [[.tutorials:visual_tutorial|Basic visualization tutorial]]
   *  [[.tutorials:pdf|Embed interactive visualizations in PDF files]]
=== Miscellaneous ===
   *  [[.tutorials:regular_subdivisions|Regular Subdivisions]]
   *  [[.tutorials:lattice_polytopes_tutorial|Lattice polytopes in polymake]]
   *  [[.tutorials:face_lattice_tutorial|Face Lattices (of Polytopes)]]
   *  [[.tutorials:pcom|Polyhedral complexes]]
   *  [[.tutorials:voronoi|Voronoi diagrams]]
   *  [[.tutorials:random|Random constructions]]
   *  [[.tutorials:polynomials_tutorial|Computing with polynomials]]
   *  [[.tutorials:aut_of_graphs|Automorphisms of graphs]] 
   *  [[.tutorials:chain_complex_homology|General chain complexes and their homology]] 
   *  [[.tutorials:persistent_homology|Persistent Homology]] 
   *  {{tutorial:flowtest.pdf|1-flowing matroids (pdf)}}  by [[https://research-repository.uwa.edu.au/en/persons/gordon-royle|Gordon F. Royle]]
   * [[.tutorials:mega2013|Wronski Polynomial Systems with polymake and Singular (Mega2013 submission)]]
   * [[.tutorials:patchwork|Patchworking real tropical hypersurfaces]]

===== Technical Guides =====
   *  [[.tutorials:data|Save and load data in polymake]]
   *  [[.tutorials:tarballs|Save and load an array of polytopes]]
   *  [[.tutorials:time|Measure execution time]]
   *  [[.tutorials:legacy|If you have not used polymake in a very long time]]

==== Configuration and tweaking ====
   * [[install:configure|Configuring polymake for a group of users]]
   * [[.howto:shell_custom|Customizing the polymake interactive shell]]
   * [[user_guide:howto:interface_config| Configure interfaces to other software]]
   * [[user_guide:howto:jupyter|Using polymake with jupyter]]

==== Advanced Users ====

Learn how to extend polymake.
  * [[.howto:scripting|Scripting]] for "power users"
  * [[.extend:clients|Writing C++ clients]]
  * [[.howto:matrix_classes|Dealing with matrices and vectors]]
  * [[:callable|Using the Callable Library]]
  * [[.extend:rulefiles|Writing rule files]]
  * [[.extend:unit_tests|Writing unit tests]]
  * [[.extend:extensions|Writing and using extensions]]
  * [[.extend:upgrade_rules|Dealing with data model changes]]

Details on selected topics, also linked from general pages above.
  * [[.extend:rules|Production rules]]
  * [[.extend:help_formatting|Formatting help blocks]]
  * [[.extend:permutations|Permutations]]
  * [[.extend:polymorphic|Polymorphic functions]]
  * [[.extend:cpp_type_binding|Property type binding to C++ classes]]

===== Developers Corner =====
  * [[dev_corner:start|Guides for developers]]