{
"cells": [
{
"cell_type": "markdown",
"id": "6537d267",
"metadata": {},
"source": [
""
]
},
{
"cell_type": "raw",
"id": "a7a5972c",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
"########\n",
"Examples\n",
"########\n",
"\n",
"Here we show a selection of examples of using cweqgen.\n",
"\n",
"Generating an equation\n",
"======================\n",
"\n",
"To generate an equation you just need the correct name for the equation, as given in the\n",
":ref:`Equations` section, and the :func:`~cweqgen.equations.equations` function. To generate\n",
"the equation for the gravitational-wave amplitude :math:`h_0` you would do:"
]
},
{
"cell_type": "code",
"execution_count": 1,
"id": "938f7cbe",
"metadata": {},
"outputs": [],
"source": [
"from cweqgen import equations\n",
"eq = equations(\"h0\")"
]
},
{
"cell_type": "raw",
"id": "47d276f7",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
"If you print the returned :class:`~cweqgen.equations.EquationBase` object (called ``eq`` in this\n",
"case) it will return a LaTeX string, via the :meth:`~cweqgen.equations.EquationBase.equation`\n",
"method, giving the equation (note that the equation is not enclosed in \"$\" symbols):"
]
},
{
"cell_type": "code",
"execution_count": 2,
"id": "d6b05def",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"% equation generated with cweqgen v0.4.2.dev2+gb08a31c.d20220426:\n",
"% equations(equation=\"h0\")\n",
"h_0 = \\frac{16 G}{c^{4}} \\pi^{2}\\frac{\\varepsilon I_{zz}}{d} f_{\\rm rot}^{2}\n"
]
}
],
"source": [
"print(eq)"
]
},
{
"cell_type": "raw",
"id": "7cb6d505",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
"If working in a Jupyter notebook, you can show the typeset LaTeX equation by just running a cell\n",
"containing ``eq``:"
]
},
{
"cell_type": "code",
"execution_count": 3,
"id": "65896ce2",
"metadata": {},
"outputs": [
{
"data": {
"text/latex": [
"$% equation generated with cweqgen v0.4.2.dev2+gb08a31c.d20220426:\n",
"% equations(equation=\"h0\")\n",
"h_0 = \\frac{16 G}{c^{4}} \\pi^{2}\\frac{\\varepsilon I_{zz}}{d} f_{\\rm rot}^{2}$"
],
"text/plain": [
"% equation generated with cweqgen v0.4.2.dev2+gb08a31c.d20220426:\n",
"% equations(equation=\"h0\")\n",
"h_0 = \\frac{16 G}{c^{4}} \\pi^{2}\\frac{\\varepsilon I_{zz}}{d} f_{\\rm rot}^{2}"
]
},
"execution_count": 3,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"eq"
]
},
{
"cell_type": "raw",
"id": "6edb51e4",
"metadata": {
"raw_mimetype": "text/restructuredtext"
},
"source": [
"Equation as a figure\n",
"--------------------\n",
"\n",
"You can return an equation as an object containing a :class:`matplotlib.figure.Figure`, which can then be saved in whatever format you require by using the :meth:`~cweqgen.equations.EquationBase.equation` method with the ``displaytype`` keyword set to ``\"matplotlib\"``. If running this in a Jupyter notebook, a png version of the equation will be shown."
]
},
{
"cell_type": "code",
"execution_count": 4,
"id": "71062a47",
"metadata": {},
"outputs": [
{
"data": {
"image/png": "iVBORw0KGgoAAAANSUhEUgAAARoAAABKCAYAAABkSpv5AAAAOXRFWHRTb2Z0d2FyZQBNYXRwbG90bGliIHZlcnNpb24zLjUuMSwgaHR0cHM6Ly9tYXRwbG90bGliLm9yZy/YYfK9AAAACXBIWXMAAB7CAAAewgFu0HU+AAAK1ElEQVR4nO2d8XXiuhLGv3nnFeDN64DtgGUruNBB2K3gJh2EsxXcw3bApoK9pAOyFdwlHYQObkIH8/7QCCvGBhuQLcj3O4dDYstYlqXPo9FIFlUFIYTE5D9dZ4AQcvlQaAgh0aHQEEKiQ6EhhESHQkMIiQ6FhhASHQoNISQ6FBpCSHQoNISQ6FBoCCHRodAQQqJDoSGERIdCQwiJDoWGEBIdCg0hJDoUGkJIdCg0hJDoUGgIIdGh0BBCokOheeeIyLWIzEVkKSIL+8xEJLP9UxHpd5zNk2HXuxCRV/ss7fp7XeftkhEuTp4u1tjnAOaq+mNP2hsAIwAvtulZVb/vSH8NYArgCcBEVVfBvh6AGYAVgBtVlWOuI0VE5BlAD8AHVV13nJ2L579dZ4BsIyIzAFf27xDAYkfaDE6MnlR1bNt6AJYi8qSqjyXHTAHcARir6kNxv6quROQWwDOcEEXF8tOzDwDM9gnrkefL7FxP5ywybZfbMVBoEkRVb4FNg7jek/zejpkE23zFeykm3icyQR5WIvKIyEIjIgs4i+rJ/h8CWIjIyAtnBAb2vSXC50JH5XYw9NGcMVa5fBdog6o+quoHXwkL6e8A/NglMgEr7LCmjkVE7uCewpt8mgX2HcC1de9iMLLvaNcWkw7L7WAoNOfNGHCVTET6InJnzs6sIv3cvqcV+7fSl3W9TsgIwLwkvz+D/XsRkaE5dJ9FRO171zUO7ft3s+wmw0nKrU2SERoR6dlowLONBjx3naczYABsHME9AD/grJClbdtg1kwG55dYoQaRRQZw3bJ1yXa/be9IkAnKCK6RjQB8gAnwjpGkPoBVqv4ZEclMOOc26ndTSHJ0ubVNMkJjlf8WwAOsQXSaofNgU6FU9UFV12ZOjwHMCsPS/in3E4mgqhPr4q0Lu7zFsbNrY0/0zH7nQVVXvgxs25agBmWSsn/mF4AX87X04e5leK+PKrcuSMoZbA7If+3f5AorYf4O/1HVJxEBXBfJC0xm36XWjDXae/vXO5GvACw6GMmYwFkclcPzAKCqaxEZmGMUsGvzzvQKkm2MwCbsoA9gYqI4BLCuaYXWKrcuSEpoDN8wUn7ipMIKQL+iC7BGProCuKHqSuw3fJfDx5h8rNvNOhUiMofL+x81D3mBE0Sfz31d7tTr1zcg77aKyBg1rPsDyq1Vkuk6BTRR8PfOLmdmhrfWi6+sdRyFPsakC5GBqn6q4z+xeKOJpR+r6m2Np/kArn5V/r5FRr/6iGFzspdGRzdJW5M+gvvmu4S7Dmhabl2QlNCcSf85JWbAxtG7IRiN2Phj7An5AODLjlEpb7oDLd8DayyLMAakeF0lXBWH8PecowcnwJXXZudcwlkGM7iRulXZeZqkrZk/f721y/7AcmsfVU3mAxfjoXBh753np+sPnGWhAKY70kwBLAvb5sVttj2D8008w3W5ivuv7VgFMGzxOufF/FheZ3uOWwDwI26Zffplv9e0ftlvTct+55i0e36nUf0/tNy6+CQ118mcekMAH+EqzFfblcGZkxNN1DQ8JUFoed++13DdpDWAP4tlYMOfY+TDm//o/nlOocPUHzdTF5Mz1AZD25bfG+QO531MfP5EZGnbit2DHoCfe64jg2vgX5DXkbK5W3dwXcYB8hHNFUrK0tIPAYzUoq1FJKuqd03SVhzfQ+6Y9iNLa+QO+ZGWj54dXG5dkJrQKFwh/wVngj4U9j1oC+HVu7oWdXkPgghsHg4DOHP/xf5+Qd4AhnANO5wOMVM3MjbH7ikWoyaCdwoCUZrC5bkH4Juqfjombc1zPwPo6Z5JrCmW2166NqkCk28IZzaWmu1wfWFtOR/HfBZdl2kLZeVD4cNtC7jYls196zqfDe/9HZxgTAG8Wr3rHZO2wfkVbtZ952Vx6k8yFk0w2e+7vp0g6Pe/AoCqfqg4/g7AZ+RPzqUmOpP1EvBxN/rWCZkB+KXBE11EXqvuGcmxgZAlWrLa2yalOBrvKf+ruMNHgKIinsDM91Wh0s9F5JPuDt5KCuseJosGJr0GcTcBXxCMmFjj2ZpBfgpSLyuP1l/Lx8c8/RMrL12SktDsmn/yxb63wufNGTeEm+MS8ieAVxF5M8uVRGWMtxM2B6iIRCZbeCvwIutqEkJTI37APznLljYYoyQAS114+hpudOUsrJoGT7+DsHKeqOrJZ/ea1Tks/PZHlE/+O5rYZdUB3qJpdUZ50xHGQ0klYK9yfRBfgRFEqhZm5Q5R/dT0oyC1sSUH9ASfpObSWDmGK/edmm/YfhpnqD/knQzhKgItnrarGeV1lww5iiQsGuRDdWXK6qfIz4JtM+Ti1EO1ublGwynz6uJIjnZedlBh9jGFK7ev+xIeyA3cMhUhPeS+t7NBVUdtPiiCB2er3SbzobWypETnQiP71299MwnOzP8mlSBrmqcEReIobERuikiN3gIGM2z70Na2v3+GfrIBCrPiI+Kn3rTmCDZxm+9NeCI6Fxrklb+qn7iGTbI0UbptMPyXHZe188eE2ZdfrNNM7BxFMfFd2q84IydnMCeqLavms31XlpFFAvfg2skE7sHRQ8mC5BYqksG1nQyFN2J4Xx1cNzoLrLd1tKH1rgN54LpNr6gIdLKCWsJeO4IgGMz2P6MiKMx+9yIDoGqWbYZgnhRc9+akAXR2jleUzM+Be1K/ArjuuiwaXtMNXPBc1tL5FnXOZ+kWsCBJaxfLYH9m7eG6cNxNWTuw9vTaxjV2btGom2awazX+NfKhvzKeUN0lyNCe+dsJNm/pK5zjew28eSPCVCPHEdn9KfVpqbNwkg/WK1gA/8JZGG06Zgeo9+qXFZxofLT/i2vP3MNZJW/ak6r+EJGJhXp0MgLbudCcgJ9wK79n4Y0K5iu11g9tG2/yqg0pS/4+p5+wbout2eIZAriybbEXHk8eH8kMNwnRT4q8gbOyW4kqD7pptZdYVRt9LRGmXfl+hBMpCs0hqOqDuPcPTfG2EO8BPF5qY7KJdQN9G97vnYr+aXxbOGYKF+tyFnFFLeAXjApnOvv6EsU/E4jbiz0g/D2rK2xVS7H631lXHLe2dD3tYFG5VOJojsJu2FryVePncEslJPfaiVMg+fuc3kzXULca29ai1eJWfpvZMT1xq8Kd3bDzKQkiyotTXhovPtWQG+TLfwCu2/v9BN00Lx5Zxf4MyK2hMsS9qifKe9bP3qLxaMlEzAvGjwzUegpq/oYJkuPfiVX0D46wZ6nPI/Fr5vxh1k1fTzDSoy4S/hHV/sohtsWzOA+th0hTRi7ConmHDJDwe4nOhKp5WJsGKdXvhToYE7bfcF37OZq97O0KuyO7x3A+uLtwo/1/he1JsAu44e3M/v+skeKdLsaieWesUPHk8gGQsSrMBVH2XvJi/MwU243zaA7xkZk7YIg87mVR8C1tRgAD98HmDRFaslSH+Te/A/glIr8R8Z1fyaxHQ+oTrF3yKRQU2z4FMKa1sxsLC7j3DdAE2jfmEZzV8e2ddcmjQYvmDFG3DOYnAN9EZAUX+/E/uKCsi3SAnxp7ml+ZdfBk20bWzZjA1qjuMo+XBC0aQkh06AwmhESHQkMIiQ6FhhASHQoNISQ6FBpCSHQoNISQ6FBoCCHRodAQQqJDoSGERIdCQwiJDoWGEBIdCg0hJDoUGkJIdCg0hJDoUGgIIdGh0BBCokOhIYREh0JDCIkOhYYQEp3/A6+AFllNZ25uAAAAAElFTkSuQmCC\n",
"text/plain": [
"