Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@ac812
ac812 committed Oct 8, 2023
1 parent c9b2972 commit 1aeeb6e
Show file tree
Hide file tree
Showing 53 changed files with 1,596 additions and 3,634 deletions.
Binary file modified _images/hello-jupyter.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/jupyterlab-interface.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/notebook-output.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/notebook-rename.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/run-cell.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion _sources/calling-functions.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"cells": [
{
"cell_type": "markdown",
"id": "c2306d9d",
"id": "24e0ec8a",
"metadata": {},
"source": [
"# Calling functions\n",
Expand Down
34 changes: 17 additions & 17 deletions _sources/data-structures.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"cells": [
{
"cell_type": "markdown",
"id": "0af76391",
"id": "1ba684a2",
"metadata": {},
"source": [
"# Data Structures\n",
Expand Down Expand Up @@ -30,7 +30,7 @@
{
"cell_type": "code",
"execution_count": 1,
"id": "a6d6d784",
"id": "1f0f5b18",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -39,7 +39,7 @@
},
{
"cell_type": "markdown",
"id": "dc4e631b",
"id": "0102c71d",
"metadata": {},
"source": [
"The code above creates a variable `t` which references a tuple in memory that is 10 items long. Assigning data items to\n",
Expand Down Expand Up @@ -67,7 +67,7 @@
{
"cell_type": "code",
"execution_count": 2,
"id": "d448310c",
"id": "87d14159",
"metadata": {},
"outputs": [
{
Expand All @@ -90,7 +90,7 @@
},
{
"cell_type": "markdown",
"id": "a9c68cb8",
"id": "d92aa1f9",
"metadata": {},
"source": [
"To extract more than one item from a sequence you can either:\n",
Expand All @@ -113,7 +113,7 @@
{
"cell_type": "code",
"execution_count": 3,
"id": "0f0d4869",
"id": "bacf631d",
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -165,7 +165,7 @@
},
{
"cell_type": "markdown",
"id": "09df5249",
"id": "ac75a568",
"metadata": {},
"source": [
"### Tuples are immutable\n",
Expand All @@ -176,7 +176,7 @@
{
"cell_type": "code",
"execution_count": 4,
"id": "dfb64c6a",
"id": "e86cf80a",
"metadata": {
"tags": [
"raises-exception"
Expand All @@ -202,7 +202,7 @@
},
{
"cell_type": "markdown",
"id": "d33f5c0c",
"id": "a056a173",
"metadata": {},
"source": [
"As you can see an error is thrown back saying explicitly that the `'tuple' object does not support item assignment`. Since they\n",
Expand All @@ -227,7 +227,7 @@
{
"cell_type": "code",
"execution_count": 5,
"id": "e5381d48",
"id": "92654826",
"metadata": {
"tags": [
"remove-output"
Expand Down Expand Up @@ -258,7 +258,7 @@
},
{
"cell_type": "markdown",
"id": "2671d765",
"id": "676acda9",
"metadata": {},
"source": [
"### Other useful functions\n",
Expand Down Expand Up @@ -306,7 +306,7 @@
{
"cell_type": "code",
"execution_count": 6,
"id": "b328bd7e",
"id": "c05fa5c7",
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -315,7 +315,7 @@
},
{
"cell_type": "markdown",
"id": "1d1ef901",
"id": "4b03c9d6",
"metadata": {},
"source": [
"Lists are also a Sequence type in Python and therefore support slicing, membership operators, concatenation, replication \n",
Expand All @@ -341,18 +341,18 @@
{
"cell_type": "code",
"execution_count": 7,
"id": "850d6067",
"id": "5bedfc8b",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"[55, 92, 110, 66, 75, 45, 40, 57, 55, 62]\n",
"l is referencing object 140665159630080 in memory\n",
"l is referencing object 140269091382656 in memory\n",
"\n",
"After l[2] = 80, l is: [55, 92, 80, 66, 75, 45, 40, 57, 55, 62]\n",
"l is referencing object 140665159630080 in memory\n"
"l is referencing object 140269091382656 in memory\n"
]
}
],
Expand All @@ -369,7 +369,7 @@
},
{
"cell_type": "markdown",
"id": "4af32958",
"id": "ddd93251",
"metadata": {},
"source": [
"When we tried to apply a [similar operation in tuples](#tuples-are-immutable), Python threw an exception, because tuples are immutable. Since \n",
Expand Down
48 changes: 24 additions & 24 deletions _sources/data-types.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"cells": [
{
"cell_type": "markdown",
"id": "9e199863",
"id": "4adcfbd3",
"metadata": {},
"source": [
"# Data Types\n",
Expand Down Expand Up @@ -41,7 +41,7 @@
{
"cell_type": "code",
"execution_count": 1,
"id": "0e959dbf",
"id": "9079bbec",
"metadata": {},
"outputs": [
{
Expand All @@ -64,7 +64,7 @@
},
{
"cell_type": "markdown",
"id": "aabf4aeb",
"id": "b21c0e56",
"metadata": {},
"source": [
"As shown in the example above the `float` version is inaccurate at the 17<sup>th</sup> decimal place. These inaccuracies\n",
Expand All @@ -76,7 +76,7 @@
{
"cell_type": "code",
"execution_count": 2,
"id": "6dd70bf2",
"id": "dbae0337",
"metadata": {},
"outputs": [
{
Expand All @@ -99,7 +99,7 @@
},
{
"cell_type": "markdown",
"id": "e5bc70e2",
"id": "6f7b651f",
"metadata": {},
"source": [
"## Converting data-types (type casting)\n",
Expand Down Expand Up @@ -129,7 +129,7 @@
{
"cell_type": "code",
"execution_count": 3,
"id": "d2bb0e38",
"id": "815c399b",
"metadata": {},
"outputs": [
{
Expand All @@ -152,7 +152,7 @@
},
{
"cell_type": "markdown",
"id": "70156868",
"id": "9deb3d6f",
"metadata": {},
"source": [
"```{tip}\n",
Expand Down Expand Up @@ -207,7 +207,7 @@
{
"cell_type": "code",
"execution_count": 4,
"id": "1df19b03",
"id": "fcb7c3d8",
"metadata": {},
"outputs": [
{
Expand All @@ -225,7 +225,7 @@
},
{
"cell_type": "markdown",
"id": "4afac6e4",
"id": "e22676eb",
"metadata": {},
"source": [
"If you don’t want Python to interpret escaped characters, use `r` before the string as in the example below:"
Expand All @@ -234,7 +234,7 @@
{
"cell_type": "code",
"execution_count": 5,
"id": "41d26a38",
"id": "ad2688f0",
"metadata": {},
"outputs": [
{
Expand All @@ -251,7 +251,7 @@
},
{
"cell_type": "markdown",
"id": "874d59e9",
"id": "a2ea4b64",
"metadata": {},
"source": [
"### Formatted String Literals\n",
Expand All @@ -264,7 +264,7 @@
{
"cell_type": "code",
"execution_count": 6,
"id": "419fe636",
"id": "daa3547c",
"metadata": {},
"outputs": [
{
Expand All @@ -283,7 +283,7 @@
},
{
"cell_type": "markdown",
"id": "b9cac59f",
"id": "44e8a8ad",
"metadata": {},
"source": [
"Now try one with your own name and location! \n",
Expand All @@ -294,7 +294,7 @@
{
"cell_type": "code",
"execution_count": 7,
"id": "0d6bd19b",
"id": "b18473bb",
"metadata": {},
"outputs": [
{
Expand All @@ -314,7 +314,7 @@
},
{
"cell_type": "markdown",
"id": "7a3a766f",
"id": "22a33792",
"metadata": {},
"source": [
"Here temperature is the `float` we want to print. After the `:` is the specification of how many decimal places we want it\n",
Expand Down Expand Up @@ -349,27 +349,27 @@
{
"cell_type": "code",
"execution_count": 8,
"id": "a91f0753",
"id": "b8785ac9",
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Step A\n",
"a is referencing object 140256318096400 in memory\n",
"a is referencing object 140512002868240 in memory\n",
"\n",
"Step B\n",
"a is referencing object 140256318096400 in memory\n",
"b is referencing object 140256318096400 in memory\n",
"a is referencing object 140512002868240 in memory\n",
"b is referencing object 140512002868240 in memory\n",
"\n",
"Step C\n",
"a is referencing object 140255539097008 in memory\n",
"b is referencing object 140256318096400 in memory\n",
"a is referencing object 140511231415856 in memory\n",
"b is referencing object 140512002868240 in memory\n",
"\n",
"Step D\n",
"a is referencing object 140255539097008 in memory\n",
"b is referencing object 140255539097008 in memory\n"
"a is referencing object 140511231415856 in memory\n",
"b is referencing object 140511231415856 in memory\n"
]
}
],
Expand Down Expand Up @@ -400,7 +400,7 @@
},
{
"cell_type": "markdown",
"id": "822d7104",
"id": "9b3f2f85",
"metadata": {},
"source": [
"## Garbage collection\n",
Expand Down
2 changes: 1 addition & 1 deletion _sources/debugging.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"cells": [
{
"cell_type": "markdown",
"id": "4cc7a518",
"id": "5660fb09",
"metadata": {},
"source": [
"# Debugging code in PyCharm\n",
Expand Down
Loading

0 comments on commit 1aeeb6e

Please sign in to comment.