Refactor and document operators and periods in sage module

sage/toric_topdata.sage

@@ -1,3 +1,48 @@
+"""
+Topological data of Calabi-Yau hypersurfaces and CICYs in toric ambient spaces.
+
+Contents
+--------
+Polytope
+    __init__                             Construct from a list of defining points
+    _validate_points_and_get_dimension   Check the points and return their dimension
+    _points_to_polytope                  Lattice points of the convex hull, minus codim-1 interiors
+
+ToricPolytope(Polytope)
+    __init__                             Construct with triangulation, nef partition and Mori cone
+    set_triangulation                    Select a fine star triangulation by index
+    set_nef_partition                    Set and validate the nef partition
+    set_Mori_cone                        Set the Mori cone (default or from given l-vectors)
+    disc                                 A-discriminant (singular loci in Batyrev coordinates)
+    topdata                              Compute topological data and write it to JSON
+    _set_fine_star_triangulations        Fine star triangulations of the polytope
+    _collect_linear_dependencies         Linear relations among points in all faces
+    _append_origin_weight                Add the origin weight to each relation
+    _setup_discriminant_symbols          Symbolic variables for the discriminant
+    _build_equation_system               Equation system for one block of relations
+    _eliminate_and_normalize             Eliminate lambda-variables and normalise
+    _append_unique_discriminants         Collect discriminant factors without duplicates
+    _compute_Kahler_generators           Kähler cone generators dual to the Mori cone
+    _compute_intersection_ring           Intersection ring polynomial of the CY
+    _intersection_substitution_rules     Kähler monomial -> intersection number rules
+    _replace_intersection_monomials      Substitute intersection numbers into an expression
+    _compute_Chern_character             Total Chern class via adjunction
+    _compute_Chern_polynomials           Chern polynomials with intersection numbers
+    _check_for_fibrations                Detect possible elliptic fibrations
+    _get_polytope_and_glsm_table         Table of polytope points and GLSM charges
+    _get_lvec_rows                       GLSM charge l-vectors as lists of ints
+    _get_output                          Dictionary of all topological data
+    _to_json_safe (staticmethod)         Convert values into JSON-safe primitives
+    _write_output_json                   Write the output dictionary to JSON
+
+ToricPolytopeCICY(ToricPolytope)
+    __init__                             Construct from a CICY configuration matrix
+    _CICY_to_points                      Configuration matrix -> points and nef partition
+
+ToricPolytopeProjectiveSpace(ToricPolytope)
+    __init__                             Construct from weighted projective space weights
+    _compute_points_from_weights         Weights -> polytope points
+"""
 import numpy as np
 import logging
 import os