Skip to content

Update tutorial and fix some broken links. #425

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
prabhuramachandran merged 1 commit into from
Oct 26, 2025
Merged

Update tutorial and fix some broken links. #425

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
229 changes: 146 additions & 83 deletions docs/tutorial/1_getting_started.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,7 @@
" $ pysph run --cat elliptical_drop > ed.py # This puts the source into ed.py in the current dir.\n",
" \n",
" $ python ed.py\n",
" \n",
"**NOTE: ** there is also a `<pysph_root>/old_examples` directory which you should not use.\n",
" \n",
" \n",
"You can also import the examples from Python and thus could just as well have run this example as:\n",
"\n",
" $ python -m pysph.examples.elliptical_drop\n",
Expand Down Expand Up @@ -122,20 +120,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [],
"source": [
"from __future__ import print_function"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": [
"from pysph.base.particle_array import ParticleArray"
Expand Down Expand Up @@ -170,29 +155,11 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [],
"source": []
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"outputs": [],
"source": []
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": []
"source": [
"import numpy as np"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -299,9 +266,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": [
"from pysph.base.particle_array import get_local_tag, get_ghost_tag, get_remote_tag"
Expand Down Expand Up @@ -332,9 +297,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": [
"from cyarray.carray import DoubleArray"
Expand Down Expand Up @@ -370,6 +333,25 @@
"a.length"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"a.set(1, 1)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"x = a.get_npy_array()\n",
"x"
]
},
{
"cell_type": "markdown",
"metadata": {},
Expand All @@ -383,9 +365,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": [
"empty = ParticleArray(name='dummy')"
Expand All @@ -403,11 +383,11 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": []
"source": [
"empty.pid"
]
},
{
"cell_type": "markdown",
Expand Down Expand Up @@ -450,9 +430,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": [
"import numpy as np"
Expand All @@ -461,9 +439,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": [
"pa = ParticleArray(name='f', x=[0.0, 1.0], \n",
Expand Down Expand Up @@ -522,6 +498,100 @@
"- Explore all of the above methods.\n"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"x, pid = pa.get('x', 'pid', only_real_particles=False)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"type(x)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"x, pid"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"pa.tag"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"type(pa.x)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"pa.get_carray('tag').set(1, 0)\n",
"#pa.tag[1] = 1\n",
"pa.align_particles()\n",
"pa.get_number_of_particles(real=True)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"pa.add_property('junk', default=0.0, data=0.0, stride=2)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"pa.x, pa.junk"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"pa.extend(3)\n",
"pa.align_particles()"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"pa.x, pa.junk"
]
},
{
"cell_type": "code",
"execution_count": null,
Expand All @@ -537,8 +607,8 @@
"metadata": {},
"outputs": [],
"source": [
"pa.add_property('x')\n",
"pa.x = np.arange(10)"
"pa.add_property('y')\n",
"pa.y = np.arange(5)"
]
},
{
Expand Down Expand Up @@ -592,7 +662,10 @@
{
"cell_type": "markdown",
"metadata": {
"collapsed": true
"collapsed": true,
"jupyter": {
"outputs_hidden": true
}
},
"source": [
"- `pa.get_carray(prop)`: will get you the c array.\n",
Expand Down Expand Up @@ -620,9 +693,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": [
"from pysph.base.utils import get_particle_array"
Expand All @@ -631,9 +702,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": [
"from pysph.base.utils import get_particle_array_wcsph, get_particle_array_tvf_fluid, get_particle_array_gasd"
Expand All @@ -652,11 +721,11 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": []
"source": [
"pa.output_property_arrays"
]
},
{
"cell_type": "markdown",
Expand All @@ -672,9 +741,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": [
"%matplotlib inline\n",
Expand All @@ -684,9 +751,7 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": []
},
Expand All @@ -709,16 +774,14 @@
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"collapsed": true
},
"metadata": {},
"outputs": [],
"source": []
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3",
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
Expand All @@ -732,9 +795,9 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.6.0"
"version": "3.11.11"
}
},
"nbformat": 4,
"nbformat_minor": 2
"nbformat_minor": 4
}
Loading
Loading