singular docs added

singular-gpispace · Feb 2, 2025 · 0b6616c · 0b6616c
1 parent d5ba426
commit 0b6616c
Show file tree

Hide file tree

Showing 12 changed files with 76 additions and 25 deletions.
diff --git a/docs/build/.documenter-siteinfo.json b/docs/build/.documenter-siteinfo.json
@@ -1 +1 @@
-{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-02-02T01:55:12","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-02-02T04:13:31","documenter_version":"1.8.0"}}
diff --git a/docs/build/Example.html b/docs/build/Example.html
diff --git a/docs/build/Installation.html b/docs/build/Installation.html
diff --git a/docs/build/Overview.html b/docs/build/Overview.html
diff --git a/docs/build/index.html b/docs/build/index.html
diff --git a/docs/build/objects.inv b/docs/build/objects.inv
diff --git a/docs/build/search_index.js b/docs/build/search_index.js
diff --git a/docs/make.jl b/docs/make.jl
@@ -30,7 +30,13 @@ makedocs(;
             "Overview.md",
         ],
         "Singular version of Feynman" => [
-            "feynman_lib.md",
+            "Home" =>[
+                "Installation_sing.md",
+                "Overview_sing.md",
+            ],
+            "Examples" => [
+                "Example_sing.md",
+            ],
         ],
     ],
 )

diff --git a/docs/src/Example_sing.md b/docs/src/Example_sing.md
diff --git a/docs/src/Installation_sing.md b/docs/src/Installation_sing.md
@@ -0,0 +1,37 @@
+# Installation
+
+We assume that SINGULAR is installed in a recent stable version (4.1.1 Feb 2018  or 4.3.2.0 Jan_2022 ) .
+
+Run Singular in the terminal,
+
+```singular
+ >Singular
+                     SINGULAR                                 /  Development
+ A Computer Algebra System for Polynomial Computations       /   version 4.1.1
+                                                           0<
+ by: W. Decker, G.-M. Greuel, G. Pfister, H. Schoenemann     \   Feb 2018
+FB Mathematik der Universitaet, D-67653 Kaiserslautern        \  Debian 1:4.1.1-p2+ds-4build2
+> 
+```
+
+Then install the library feynman.lib.
+```singular
+> LIB "/path_to/Singular_Feynman/feynman.lib";
+// ** redefining setMat (LIB "/path_to/Feynman/Singular_Feynman/feynman.lib";)
+// ** redefining setMat (LIB "/path_to/Feynman/Singular_Feynman/feynman.lib";)
+// ** loaded /path_to/Feynman/Singular_Feynman/feynman.lib (4.3.2.0,Jan_2022)
+// ** loaded /usr/bin/../share/singular/LIB/general.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/matrix.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/nctools.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/random.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/ring.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/primdec.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/absfact.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/triang.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/elim.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/poly.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/inout.lib (4.1.1.0,Dec_2017)
+// ** loaded /usr/bin/../share/singular/LIB/linalg.lib (4.1.1.0,Dec_2017)
+> 
+```
+
diff --git a/docs/src/Overview_sing.md b/docs/src/Overview_sing.md
@@ -0,0 +1,13 @@
+@doc raw"""
+proc printMat(matrix M)
+
+**USAGE**   :  printMat(M); M matrix@*
+**ASSUME**  :  M is a matrix.
+**THEORY**  :  This is the print function used by Singular to print a matrix.
+**KEYWORDS**: matrix
+```singular
+ring R=0,(x),lp;
+matrix M[2][3]=1,243,3,4,522222,6;
+printMat(M);
+````
+"""
diff --git a/docs/src/feynman_lib.md b/docs/src/feynman_lib.md
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-02-02T01:55:12","documenter_version":"1.8.0"}}
		{"documenter":{"julia_version":"1.9.4","generation_timestamp":"2025-02-02T04:13:31","documenter_version":"1.8.0"}}