Skip to content

Commit

Permalink
Documentation fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
Kasper Peeters committed Aug 2, 2024
1 parent d9221be commit ae3b477
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 60 deletions.
28 changes: 14 additions & 14 deletions core/algorithms/eliminate_metric.cnb
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,12 @@
"cell_type": "input",
"cells": [
{
"cell_id": 13340122236411534882,
"cell_id": 15552618808454340805,
"cell_origin": "server",
"cell_type": "latex_view",
"cells": [
{
"cell_id": 11333410999712696013,
"cell_id": 17909960130070292947,
"cell_origin": "server",
"cell_type": "input_form",
"source": "g_{m p} g^{p m}"
Expand All @@ -36,12 +36,12 @@
"source": "\\begin{dmath*}{}g_{m p} g^{p m}\\end{dmath*}"
},
{
"cell_id": 17894985963178002384,
"cell_id": 346245979832968625,
"cell_origin": "server",
"cell_type": "latex_view",
"cells": [
{
"cell_id": 5593101152482251246,
"cell_id": 18301710340624209207,
"cell_origin": "server",
"cell_type": "input_form",
"source": "g^{p}_{p}"
Expand All @@ -58,12 +58,12 @@
"cell_type": "input",
"cells": [
{
"cell_id": 11832355180757837612,
"cell_id": 692499475391029252,
"cell_origin": "server",
"cell_type": "latex_view",
"cells": [
{
"cell_id": 1419432383822709486,
"cell_id": 12623500600163379539,
"cell_origin": "server",
"cell_type": "input_form",
"source": "10"
Expand Down Expand Up @@ -110,30 +110,30 @@
"cell_type": "input",
"cells": [
{
"cell_id": 2830738818925621002,
"cell_id": 934843099193461823,
"cell_origin": "server",
"cell_type": "latex_view",
"source": "\\begin{dmath*}{}\\text{Property Indices(position=fixed) attached to~}\\left[a,~\\discretionary{}{}{} b,~\\discretionary{}{}{} c,~\\discretionary{}{}{} d,~\\discretionary{}{}{} e,~\\discretionary{}{}{} f\\right].\\end{dmath*}"
"source": "\\begin{dmath*}{}\\text{Property Indices(position=fixed) attached to~}\\left[a, \\discretionary{}{}{}b, \\discretionary{}{}{}c, \\discretionary{}{}{}d, \\discretionary{}{}{}e, \\discretionary{}{}{}f\\right].\\end{dmath*}"
},
{
"cell_id": 9384043968720976150,
"cell_id": 816358059307477494,
"cell_origin": "server",
"cell_type": "latex_view",
"source": "\\begin{dmath*}{}\\text{Property Metric attached to~}g_{a b}.\\end{dmath*}"
},
{
"cell_id": 3632907748806720927,
"cell_id": 2839007278772691664,
"cell_origin": "server",
"cell_type": "latex_view",
"source": "\\begin{dmath*}{}\\text{Property TableauSymmetry attached to~}g^{a b}.\\end{dmath*}"
},
{
"cell_id": 14029841914135557336,
"cell_id": 13817763760227715534,
"cell_origin": "server",
"cell_type": "latex_view",
"cells": [
{
"cell_id": 16107652404209191630,
"cell_id": 10707513932396855145,
"cell_origin": "server",
"cell_type": "input_form",
"source": "X_{a} g^{a b} g_{b c} g^{c d} g_{d e} g^{e f}"
Expand All @@ -142,12 +142,12 @@
"source": "\\begin{dmath*}{}X_{a} g^{a b} g_{b c} g^{c d} g_{d e} g^{e f}\\end{dmath*}"
},
{
"cell_id": 11123767540161473056,
"cell_id": 15694279202429955163,
"cell_origin": "server",
"cell_type": "latex_view",
"cells": [
{
"cell_id": 10523281001881141507,
"cell_id": 16096105714669192847,
"cell_origin": "server",
"cell_type": "input_form",
"source": "X_{e} g^{e f}"
Expand Down
103 changes: 57 additions & 46 deletions core/properties/Metric.cnb
Original file line number Diff line number Diff line change
@@ -1,68 +1,79 @@

{
"cells" :
[

"cell_id": 502887745135165894,
"cells": [
{
"cell_origin" : "client",
"cell_type" : "latex",
"cells" :
[

"cell_id": 1870763346216562312,
"cell_origin": "client",
"cell_type": "latex",
"cells": [
{
"cell_origin" : "client",
"cell_type" : "latex_view",
"source" : "\\property{Metric}{Makes a two-tensor a metric.}\n\nLabels the object as a symmetric tensor, and optionally gives it the\nindicated signature through the {\\tt signature} parameter."
"cell_id": 16590113103145697158,
"cell_origin": "client",
"cell_type": "latex_view",
"source": "\\property{Metric}{Makes a two-tensor a metric.}\n\nLabels the object as a symmetric tensor, and optionally gives it the\nindicated signature through the {\\tt signature} parameter."
}
],
"hidden" : true,
"source" : "\\property{Metric}{Makes a two-tensor a metric.}\n\nLabels the object as a symmetric tensor, and optionally gives it the\nindicated signature through the {\\tt signature} parameter."
"hidden": true,
"source": "\\property{Metric}{Makes a two-tensor a metric.}\n\nLabels the object as a symmetric tensor, and optionally gives it the\nindicated signature through the {\\tt signature} parameter."
},

{
"cell_origin" : "client",
"cell_type" : "input",
"cells" :
[

"cell_id": 6115743091450954657,
"cell_origin": "client",
"cell_type": "input",
"cells": [
{
"cell_origin" : "server",
"cell_type" : "latex_view",
"source" : "\\begin{dmath*}{}g_{m n} A^{n p}\\end{dmath*}"
"cell_id": 8587770812173137284,
"cell_origin": "server",
"cell_type": "latex_view",
"cells": [
{
"cell_id": 4066497848239046753,
"cell_origin": "server",
"cell_type": "input_form",
"source": "g_{m n} A^{n p}"
}
],
"source": "\\begin{dmath*}{}g_{m n} A^{n p}\\end{dmath*}"
},

{
"cell_origin" : "server",
"cell_type" : "error",
"source" : "{\\color{red}{\\begin{verbatim}Traceback (most recent call last):\n File \"<string>\", line 3, in <module>\nNameError: name 'eliminate_metric' is not defined\n\\end{verbatim}}}"
"cell_id": 9658144980223638993,
"cell_origin": "server",
"cell_type": "latex_view",
"cells": [
{
"cell_id": 8233761168233916260,
"cell_origin": "server",
"cell_type": "input_form",
"source": "A_{m}^{p}"
}
],
"source": "\\begin{dmath*}{}A_{m}\\,^{p}\\end{dmath*}"
}
],
"source" : "g_{m n}::Metric(signature=1).\nex:= g_{m n} A^{n p};\neliminate_metric(_);"
"source": "g_{m n}::Metric(signature=1).\nex:= g_{m n} A^{n p};\neliminate_metric(_);"
},

{
"cell_origin" : "client",
"cell_type" : "latex",
"cells" :
[

"cell_id": 1399993026065074684,
"cell_origin": "client",
"cell_type": "latex",
"cells": [
{
"cell_origin" : "client",
"cell_type" : "latex_view",
"source" : "Objects declared as \\prop{Metric} can be used to automatically\nraise or lower indices using the\n\\algo{eliminate_metric} algorithm, as above.\n"
"cell_id": 10234102992620672473,
"cell_origin": "client",
"cell_type": "latex_view",
"source": "Objects declared as \\prop{Metric} can be used to automatically\nraise or lower indices using the\n\\algo{eliminate_metric} algorithm, as above.\n"
}
],
"hidden" : true,
"source" : "Objects declared as \\prop{Metric} can be used to automatically\nraise or lower indices using the\n\\algo{eliminate_metric} algorithm, as above.\n"
"hidden": true,
"source": "Objects declared as \\prop{Metric} can be used to automatically\nraise or lower indices using the\n\\algo{eliminate_metric} algorithm, as above.\n"
},

{
"cell_origin" : "client",
"cell_type" : "input",
"source" : ""
"cell_id": 9140251695264754467,
"cell_origin": "client",
"cell_type": "input",
"source": ""
}
],
"description" : "Cadabra JSON notebook format",
"version" : 1.0
"description": "Cadabra JSON notebook format",
"version": 1.0
}

1 change: 1 addition & 0 deletions web2/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@ set(PROPS
Determinant
Diagonal
DiracBar
Distributable
EpsilonTensor
FilledTableau
GammaMatrix
Expand Down

0 comments on commit ae3b477

Please sign in to comment.