Tutorials and Doc (#191)

* Tutorial doc update
* update doc tutorial
* doc not compiling

---------

Co-authored-by: Dario Coscia <dcoscia@euclide.maths.sissa.it>
Co-authored-by: Dario Coscia <dariocoscia@Dario-Coscia.local>
This commit is contained in:
Nicola Demo
2023-10-23 12:48:09 +02:00
parent ac829aece9
commit 0c8072274e
93 changed files with 2306 additions and 1685 deletions

View File

@@ -5,29 +5,15 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Tutorial 6: How to Use Geometries in PINA"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Built-in Geometries"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"# Tutorial: Building custom geometries with PINA `Location` class\n",
"\n",
"In this tutorial we will show how to use geometries in PINA. Specifically, the tutorial will include how to create geometries and how to visualize them. The topics covered are:\n",
"\n",
"* Creating CartesianDomains and EllipsoidDomains\n",
"* Getting the Union and Difference of Geometries\n",
"* Sampling points in the domain (and visualize them)\n",
"\n",
"We import the relevant modules."
"We import the relevant modules first."
]
},
{
@@ -45,6 +31,14 @@
" ax.scatter(pts.extract('x'), pts.extract('y'), color='blue', alpha=0.5)"
]
},
{
"attachments": {},
"cell_type": "markdown",
"metadata": {},
"source": [
"## Built-in Geometries"
]
},
{
"attachments": {},
"cell_type": "markdown",
@@ -401,7 +395,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"Because the `Location` class we are inherting from requires both a sample method and `is_inside` method, we will create them and just add in \"pass\" for the moment."
"Because the `Location` class we are inherting from requires both a `sample` method and `is_inside` method, we will create them and just add in \"pass\" for the moment."
]
},
{