Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
weisscharlesj committed Aug 4, 2024
1 parent fbea79c commit 1e232a2
Show file tree
Hide file tree
Showing 37 changed files with 49,551 additions and 607 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8,809 changes: 8,809 additions & 0 deletions _images/0d152b470ff636ec5c6e7c5442c0815661c72de96c26e5cd81c570c596dc0d04.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,832 changes: 1,832 additions & 0 deletions _images/29dd90bc3de91b31ed548d79a946158fdfa29f630a40d068a85621faaf546e0b.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3,063 changes: 3,063 additions & 0 deletions _images/563b800d8106f85dc1f9391f32787489794335407263a72eba314cd86b8cdb93.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,802 changes: 1,802 additions & 0 deletions _images/59dc7c40f39c8cbfc13624bbf2b905cedd7b3b0ce9ea0e88833762e6194c21cc.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,236 changes: 1,236 additions & 0 deletions _images/73e387f837f1d0aaee41c60b5d065a4f20262549e7b364cde7fd848660c1ede4.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5,359 changes: 5,359 additions & 0 deletions _images/7bffb6cbde1ae4a790f5e0900253faa995fd4a4bd594ca3c5b7557f37440d406.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3,283 changes: 3,283 additions & 0 deletions _images/8315bf794008f2a0edd5b81ef8fcc537e1154905d892ba274175d6f8f6deeb86.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,807 changes: 1,807 additions & 0 deletions _images/89702564c5464150caf08bcd0b1e2ce5d9c7bc2b4e4be5c98b8a2d08f0fc95ba.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3,584 changes: 3,584 additions & 0 deletions _images/9d17b99abcf0ddaaed5f7443acf2b10347d43dd94516a29fe123800fcd9fd52e.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,049 changes: 1,049 additions & 0 deletions _images/bd5d97070b0b07052482042095342ee48e6966cff223f6b190e55a3724d1a911.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3,549 changes: 3,549 additions & 0 deletions _images/c60e8a9583f2f7c4ab3867966bac84a64ed975f297210b26aba762b677857603.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,827 changes: 1,827 additions & 0 deletions _images/f761fbd70dbad69b1aaa644c2a810e4f12b8f32a86f3fcd533b9e88182e0cc04.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1,271 changes: 1,271 additions & 0 deletions _images/fbd69499546a119a61dc9f92c26f9fe6b5f110e80fb329d5b1abff4069c4b181.svg

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions _sources/notebooks/chapter_00/chap_00_notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"id": "e2d4847a-c522-4685-8354-ba2a9e54a516",
"metadata": {},
"source": [
"Python is a popular programming language available on all major computer platforms including Mac, Linux, and Windows. It is a scripting language which means that the moment the user presses the Return key or Run, the Python software interprets and runs the code. This is in contrast to a compiled language like C where the code must first be translated into binary (i.e., machine language) before it can be run. On-the-fly interpretation makes Python quick to use and often provides the user with rapid results. This is ideal for scientific data analysis where the user is routinely making changes to the processing and visualization of the data.\n",
"Python is a popular programming language available on all major computer platforms including macOS, Linux, and Windows. It is a scripting language which means that the moment the user presses the Return key or Run, the Python software interprets and runs the code. This is in contrast to a compiled language like C where the code must first be translated into binary (i.e., machine language) before it can be run. On-the-fly interpretation makes Python quick to use and often provides the user with rapid results. This is ideal for scientific data analysis where the user is routinely making changes to the processing and visualization of the data.\n",
"\n",
"Python is free, open source software and is maintained by the non-profit [Python Software Foundation](https://www.python.org/psf/). This is appealing for two major reasons. The first is that it is widely, freely, and irrevocably available to anyone who wants to use it regardless of budget. With proprietary software, which is more and more commonly offered under a subscription model, if a company stops offering or updating a software package, it may simply become unavailable leaving users without the software they built their work around. Second, it is open source, so anyone can inspect and modify the code. This allows anyone to review the code to ensure it does what it claims instead of relying on the assertions of the software distributer.\n",
"\n",
Expand Down Expand Up @@ -95,9 +95,9 @@
"\n",
"Most libraries can be installed using either of the above commands, but a few can only be installed with one. You should do a quick internet search to see which is the prefered method for a particular library before installing it. The `pip list` or `conda list` command will display a list of all libraries currently installed with version numbers. To perform an update, the following two commands may be used for many libraries. Again, check to see which is preferred for a particular library.\n",
"\n",
"`pip install <library> --update`\n",
"`pip install <library> --upgrade`\n",
"\n",
"`conda upgrade <library>`"
"`conda update <library>`"
]
},
{
Expand Down
29 changes: 18 additions & 11 deletions _sources/notebooks/chapter_01/chap_01_notebook.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -1689,7 +1689,7 @@
{
"data": {
"text/plain": [
"'The compound urea is a molecular compound and urea has a molecular mass of 60.06 g/mol.'"
"'The compound urea is a molecular compound and urea has a molar mass of 60.06 g/mol.'"
]
},
"execution_count": 62,
Expand All @@ -1699,7 +1699,7 @@
],
"source": [
"'The compound {0} is a molecular compound \\\n",
"and {0} has a molecular mass of {1} g/mol.'.format(compound, MW)"
"and {0} has a molar mass of {1} g/mol.'.format(compound, MW)"
]
},
{
Expand Down Expand Up @@ -1770,7 +1770,7 @@
"```{index} boolean logic\n",
"```\n",
"\n",
"Python supports *Boolean logic* where all expressions are evaluated to either `True` or `False`. These are useful for adding conditions to scripts. For example, if you are writing code to determine if a sample is a neutral pH, you will want to test if the pH equals 7. If the `pH == 7` evaluates as `True`, the sample is neutral, and if this statement is `False`, the sample is not neutral.\n",
"Python supports *Boolean logic* where all expressions are evaluated as either `True` or `False`. These are useful for adding conditions to scripts. For example, if you are writing code to determine if a sample is a neutral pH, you will want to test if the pH equals 7. If the `pH == 7` evaluates as `True`, the sample is neutral, and if this statement is `False`, the sample is not neutral.\n",
"\n",
"(1.4.1)=\n",
"### 1.4.1 Boolean Basics\n",
Expand Down Expand Up @@ -1821,7 +1821,7 @@
"|`is` | Identity |\n",
"|`is not` | Negative identity |\n",
"\n",
"The is and is not Boolean operators are not as intuitive. These two operators test to see if two objects are the *same thing* (i.e., identity) or *not the same thing*, respectively. For example, if we test 8 and 8.0 for equality, the result is True because they are the same quantity. However, if we test for identity, the result is `False` because 8 is an integer and 8.0 is a float."
"The `is` and `is not` Boolean operators are not as intuitive. These two operators test to see if two objects are the *same thing* (i.e., identity) or *not the same thing*, respectively. For example, if we test 8 and 8.0 for equality, the result is True because they are the same quantity. However, if we test for identity, the result is `False` because 8 is an integer and 8.0 is a float."
]
},
{
Expand Down Expand Up @@ -1866,7 +1866,7 @@
},
{
"cell_type": "code",
"execution_count": 68,
"execution_count": 169,
"metadata": {
"editable": true,
"slideshow": {
Expand All @@ -1883,7 +1883,7 @@
"text": [
"<>:1: SyntaxWarning: \"is\" with a literal. Did you mean \"==\"?\n",
"<>:1: SyntaxWarning: \"is\" with a literal. Did you mean \"==\"?\n",
"/var/folders/zy/7y6kpdbx6p1ffrp1vtxy3ttc0000gn/T/ipykernel_5008/1557232650.py:1: SyntaxWarning: \"is\" with a literal. Did you mean \"==\"?\n",
"/var/folders/zy/7y6kpdbx6p1ffrp1vtxy3ttc0000gn/T/ipykernel_1040/1557232650.py:1: SyntaxWarning: \"is\" with a literal. Did you mean \"==\"?\n",
" 8 is 8.0\n"
]
},
Expand All @@ -1893,7 +1893,7 @@
"False"
]
},
"execution_count": 68,
"execution_count": 169,
"metadata": {},
"output_type": "execute_result"
}
Expand Down Expand Up @@ -1926,7 +1926,7 @@
"|`or` | Tests for either being `True` |\n",
"|`not` | Tests for `False` |\n",
"\n",
"The `and` operator requires both input values to be `True` in order to return `True` while the `or` operator requires only one input value to be `True` in order to evaluate as `True`. The not operator is different in that it only takes a single input value and returns `True` if and only if the input value is `False`. It is essentially a test for `False`."
"The `and` operator requires both input values to be `True` in order to return `True` while the `or` operator requires only one input value to be `True` in order to evaluate as `True`. The `not` operator is different in that it only takes a single input value and returns `True` if and only if the input value is `False`. It is essentially a test for `False`."
]
},
{
Expand Down Expand Up @@ -2083,6 +2083,13 @@
"bool(0)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Python also accepts any non-zero value as `True`."
]
},
{
"cell_type": "code",
"execution_count": 75,
Expand Down Expand Up @@ -2157,7 +2164,7 @@
"(1.4.4)=\n",
"### 1.4.4 `any()` & `all()`\n",
"\n",
"It is sometimes helpful to test if any or all values test `True` in a list or tuple covered in [section 1.6](1.6). The `any()` and `all()` functions do exactly this. The former will return `True` if one or more of the values in the object test `True` while the latter will only evaluate as `True` only if all values are `True`."
"It is sometimes helpful to test if any or all values test `True` in a list or tuple (covered in [section 1.6](1.6)). The `any()` and `all()` functions do exactly this. The former will return `True` if one or more of the values in the object test `True` while the latter will only evaluate as `True` only if all values are `True`."
]
},
{
Expand Down Expand Up @@ -2311,7 +2318,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"The in operator also works for other objects beyond strings including lists and tuples which you will learn about in [section 1.6](1.6)."
"The `in` operator also works for other objects beyond strings including lists and tuples which you will learn about in [section 1.6](1.6)."
]
},
{
Expand Down Expand Up @@ -3856,7 +3863,7 @@
{
"data": {
"text/plain": [
"np.float64(25.0)"
"25.0"
]
},
"execution_count": 138,
Expand Down
Loading

0 comments on commit 1e232a2

Please sign in to comment.