Merge pull request #6947 from LMFDB/main

main -> dev

Author: AndrewVSutherland

Development.md

@@ -337,7 +337,7 @@ Code Attribution
 ----------------
 
 Each file should begin with a short copyright information, mentioning the people
-who are mainly involved in coding this particular python file. In practice, 
+who are mainly involved in coding this particular python file. 
 
 
 Testing
@@ -360,6 +360,62 @@ Testing
   ```
   it produces beautiful coverage scores in `lmfdb/cover/index.html`
 
+Code Snippets 
+-------------
+
+Many of the LMFDB pages include code snippets which describe how to generate the objects on the page using computer algebra systems such as SageMath, Magma, pari/GP or Oscar. To add code snippets to a new page, the relevant code is placed in a file named `code.yaml`. The file should always define the languages used using the `prompt` tag, for example: 
+```
+prompt:
+  sage:   'sage'
+  pari:   'gp'
+  magma:  'magma'
+  oscar:  'oscar'
+```
+
+The code snippets should be formatted as template strings, which will then be formatted in the code when the page is loaded.
+```yaml # From number_fields/code.yaml
+field:
+  comment: Define the number field
+  sage: x = polygen(QQ);  K.<a> = NumberField(%s)
+  pari: K = bnfinit(%s, 1)
+  magma: R<x> := PolynomialRing(Rationals()); K<a> := NumberField(%s);
+  oscar: Qx, x = polynomial_ring(QQ); K, a = number_field(%s)
+```
+
+### Snippet testing
+
+Sometimes computer algebra systems make breaking changes which render the code snippets invalid. To catch this, there's a testing system for snippets implemented in `lmfdb/tests/generate_snippet_tests.py`. This runs the code line by line in the various CAS-es, excluding magma. It does not test correctness of the results, only consistency, by comparing with previous results stored in the `lmfdb/tests/snippet_tests` directory. Normally (and at the time of writing), this is run automatically by Github Actions, which generates the relevant log files. However, it is possible to run it manually using the CLI tool
+
+```bash
+sage --python ./lmfdb/tests/generate_snippet_tests.py  -h
+```
+which takes a number of arguments (of which one of the positional arguments `generate` and `test` are required). 
+
+To specify which code snippets should be tested in the Github Action, add a tag of the form 
+
+```yaml
+# e.g. in /lmfdb/number_fields/code.yaml
+...
+snippet_test:                   
+  testQ: 
+    label: 1.1.1.1
+    langs:
+      - sage
+      - magma
+      - oscar
+      - gp
+    url: NumberField/1.1.1.1/download/{lang}
+```
+
+The tag `langs` here is optional, and if omitted, all (available) languages in the `prompt` tag will be used. 
+
+### Snippet test and generate Github Actions
+
+Part of the code snippet testing system is a pair of code actions to generate evaluation log files automatically. The first one runs when a change to a `code*.yaml` file is pulled to the main branch, and if so, regenerates the evaluation files. If the output is different from the previous evaluation files, it will make a pull request, allowing you to manually check that the output is as expected. The logic is in `.github/workflows/snippet_generate.yml`.
+
+Additionally, there's a second CI which runs twice a month and checks that the evaluations are consistent - it can also be run on demand. This ensures that if and when SageMath (or another CAS) deprecates a function, we'll know without having to wait for someone to update the yaml files, rerun the code or submit a bug report. If this action generates a different output than what's stored in the evaluation files, it will error, and upload the diff as an artifact. This is in `.github/workflows/snippet_test.yml`. Furthermore, it will create/update an issue (see https://github.com/LMFDB/lmfdb/issues/6810 for example) which keeps track of all the evaluation errors.
+
+
 Pro Tip: Debugging
 -------------------
 

lmfdb/artin_representations/main.py

@@ -528,6 +528,7 @@ class ArtinSearchArray(SearchArray):
     jump_egspan = "e.g. 4.5648.6t13.b.a"
     jump_knowl = "artin.search_input"
     jump_prompt = "Label"
+    has_diagram = False
 
     def __init__(self):
         dimension = TextBox(

lmfdb/belyi/main.py

@@ -888,6 +888,7 @@ def labels_page():
 class BelyiCommonSearchArray(SearchArray):
     jump_knowl = "belyi.search_input"
     jump_label = "Label"
+    has_diagram = False
 
     def __init__(self):
         self.deg = TextBox(

lmfdb/bianchi_modular_forms/bianchi_modular_form.py

@@ -706,6 +706,7 @@ class BMFSearchArray(SearchArray):
     jump_egspan = "e.g. 2.0.4.1-65.2-a (single form) or 2.0.4.1-65.2 (space of forms at a level)"
     jump_prompt = "Label"
     jump_knowl = "mf.bianchi.search_input"
+    has_diagram = False
 
     def __init__(self):
         field = TextBox(

lmfdb/characters/code.yaml

@@ -94,6 +94,16 @@ galois_orbit:
     order := Order(chi);
     { chi^k : k in [1..order-1] | GCD(k,order) eq 1 };
 
+value_field:
+  comment: Field of values of chi
+  sage: CyclotomicField(chi.multiplicative_order())
+  pari: nfinit(polcyclo(charorder(g,chi)))
+  magma: CyclotomicField(Order(chi));
+
+kernel_field:
+  comment: Fixed field
+  sage: chi.fixed_field()
+
 gauss_sum:
   comment: Gauss sum
   sage: chi.gauss_sum(a)
@@ -109,8 +119,9 @@ kloosterman_sum:
 
 value:
   comment: Value of chi at x
-  sage: chi(x) # x integer
-  pari: chareval(g,chi,x) \\\\ x integer, value in Q/Z'
+  sage: |
+    chi(x)  # x integer
+  pari: chareval(g,chi,x)  \\ x integer, value in Q/Z
   magma: chi(x)
 
 

lmfdb/characters/main.py

@@ -308,7 +308,6 @@ def dirichlet_character_search(info, query):
     common_parse(info, query)
 
 
-@characters_page.route("/Dirichlet")
 @characters_page.route("/Dirichlet/")
 def render_DirichletNavigation():
     if request.args:
@@ -416,7 +415,6 @@ def make_webchar(args, get_bread=False):
         return WebSmallDirichletCharacter(**args)
 
 
-@characters_page.route("/Dirichlet/<modulus>")
 @characters_page.route("/Dirichlet/<modulus>/")
 @characters_page.route("/Dirichlet/<int:modulus>/<int:number>")
 @characters_page.route("/Dirichlet/<int:modulus>/<orbit_label>")  # orbit_label is a Cremona_letter_code identifying the orbit
@@ -557,6 +555,8 @@ def dirchar_code_download(label, download_type):
     Render a text page to download all Magma/Sage/PariGP code snippets for the various Dirichlet character pages
     Returns code snippets for either the individual Dirichet character, character orbit, or character group, depending on label
     """
+    sorted_code_names = ['character_init', 'kronecker_symbol', 'modulus', 'conductor', 'order',
+                         'is_real', 'is_primitive', 'parity', 'value_field', 'kernel_field']
     try:
         if label.count(".") == 0:
             # Group of Dirichlet characters
@@ -567,12 +567,11 @@ def dirchar_code_download(label, download_type):
             # Orbit of Dirichlet characters
             modulus, orbit_label = label.split(".")
             dc = make_webchar({'type':'Dirichlet', 'modulus':modulus, 'orbit_label':orbit_label})
-            sorted_code_names = ['character_init', 'kronecker_symbol', 'modulus', 'conductor', 'order', 'is_real', 'is_primitive', 'parity']
         elif label.count(".") == 2:
             # Individual Dirichlet character
             modulus, orbit_label, number = label.split(".")
             dc = make_webchar({'type':'Dirichlet', 'modulus':modulus, 'orbit_label':orbit_label, 'number':number})
-            sorted_code_names = ['character_init', 'kronecker_symbol', 'modulus', 'conductor', 'order', 'is_real', 'is_primitive', 'parity', 'galois_orbit']
+            sorted_code_names.insert(8, 'galois_orbit')
         else:
             return abort(404, f"Invalid label {label}")
         if label.count(".") > 0 and dc.symbol_numerator() is None:

lmfdb/characters/templates/CharacterCommon.html

@@ -83,14 +83,13 @@ <h2>
   {% if valuefield %}
   <tr>
     <td> {{KNOWL('character.dirichlet.value_field',title='Field of values')}}:</td>
-    <td> {{ valuefield | safe }} </td>
+    <td> {{ valuefield | safe }} </td> <td>{{ place_code('value_field') }}</td>
   </tr>
   {% endif %}
   {% if kerfield %}
   <tr>
     <td>{{ KNOWL('character.dirichlet.field_cut_out',title='Fixed field') }}:</td>
-    <td> {{ kerfield | safe }}
-    </td>
+    <td> {{ kerfield | safe }} </td> <td>{{ place_code('kernel_field') }}</td>
   </tr>
   {% endif %}
 </table>

lmfdb/characters/web_character.py

@@ -800,6 +800,13 @@ def title(self):
     def order(self):
         return euler_phi(self.modulus)
 
+    @cached_method
+    def code_snippets(self):
+        code = super().code_snippets()
+        # Adjust frontmatter for constructing group of Dirichlet characters
+        code["frontmatter"]["all"] = code["frontmatter"]["all"].replace("character", "character group of modulus")
+        return code
+
 
 class WebDBDirichletGroup(WebDirichletGroup, WebDBDirichlet):
     """
@@ -994,6 +1001,8 @@ def code_snippets(self):
         # Sage code in special case for modulus 1
         if self.modulus == 1:
             self._genvalues_for_code = []
+            # Sage throws error for "chi.fixed_field()" if modulus is 1
+            code['kernel_field'].pop('sage')
 
         data = {'modulus': self.modulus, 'number' : self.number,
                 'symbol_num' : self.symbol_numerator(),

lmfdb/classical_modular_forms/main.py

@@ -168,7 +168,7 @@ def index():
         # hidden_search_type for prev/next buttons
         info['search_type'] = search_type = info.get('search_type', info.get('hst', ''))
 
-        if search_type in ['List', '', 'Random']:
+        if search_type in ['List', '', 'Random', 'Diagram']:
             return newform_search(info)
         elif search_type in ['Spaces', 'RandomSpace']:
             return space_search(info)
@@ -931,7 +931,12 @@ def _AL_col(i, p):
              },
              url_for_label=url_for_label,
              bread=get_search_bread,
-             learnmore=learnmore_list)
+             learnmore=learnmore_list,
+             diagram_opts={"x_axis_default": "level",
+                           "y_axis_default": "weight",
+                           "color_default": "dim",
+                           "extra_fields": ["level"],
+                           })
 def newform_search(info, query):
     newform_parse(info, query)
     set_info_funcs(info)
@@ -1231,7 +1236,11 @@ def dimension_space_search(info, query):
                         'download':CMF_download().download_spaces},
              url_for_label=url_for_label,
              bread=get_search_bread,
-             learnmore=learnmore_list)
+             learnmore=learnmore_list,
+             diagram_opts={"x_axis_default": "level",
+                           "y_axis_default": "weight",
+                           "color_default": "dim",
+                           })
 def space_search(info, query):
     newspace_parse(info, query)
     set_info_funcs(info)
@@ -1774,10 +1783,12 @@ def search_types(self, info):
         basic = [('', 'List of forms'),
                  ('Dimensions', 'Dimension table'),
                  ('Traces', 'Traces table'),
-                 ('Random', 'Random form')]
+                 ('Random', 'Random form'),
+                 ('Diagram', 'Diagram search')]
         spaces = [('Spaces', 'List of spaces'),
                   ('SpaceDimensions', 'Dimension table'),
-                  ('RandomSpace', 'Random')]
+                  ('RandomSpace', 'Random'),
+                  ('Diagram', 'Diagram search')]
         if info is None:
             return basic
         st = self._st(info)

lmfdb/ecnf/code.yaml

@@ -131,15 +131,43 @@ localdata:
   sage:  E.local_data()
   magma: LocalInformation(E);
 
+
+# Code snippets for elliptic curve isogeny class pages
+isogeny_class:
+  comment: Define the isogeny class
+  sage: E.isogeny_class()
+  
+curves:
+  comment: List of curves in the isogeny class
+  sage: E.isogeny_class().curves
+
+isogeny_matrix:
+  comment: Isogeny matrix
+  sage: E.isogeny_class().matrix()
+
+isogeny_graph:
+  comment: Isogeny graph
+  sage: E.isogeny_class().graph().plot(edge_labels=True)
+
+
+# Code snippet tests for elliptic curve pages and isogeny class pages
 snippet_test:
+  test11.1-a: 
+    label: 11.1-a
+    langs:
+      - sage
+    url: EllipticCurve/2.0.11.1/11.1/a/download/{lang}
   test11.1-a1: 
     label: 11.1-a1
-    langs:
     url: EllipticCurve/2.0.11.1/11.1/a/1/download/{lang}
+  test81.1-CMa: 
+    label: 81.1-CMa
+    langs:
+      - sage
+    url: EllipticCurve/2.0.3.1/81.1/CMa/download/{lang}
   test81.1-CMa1: 
     label: 81.1-CMa1
-    langs:
     url: EllipticCurve/2.0.3.1/81.1/CMa/1/download/{lang}
 
 
-  
+