Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion Python/Module2_EssentialsOfPython/Functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ Write a function named `count_even`. It should accept one input argument, named

<!-- #region -->
## The `return` Statement
In general, any Python object can follow a function's `return` statement. Furthermore, an **empty** `return` statement can be specified, or the **return** statement of a function can be omitted altogether. In both of these cases, *the function will return the `None` object*.
In general, any Python object can follow a function's `return` statement. Furthermore, an **empty** `return` statement can be specified, or the **return** statement of a function can be omitted altogether. In both of these cases, *the function will return the* `None` *object*.

```python
# this function returns `None`
Expand Down
12 changes: 5 additions & 7 deletions Python/Module3_IntroducingNumpy/BasicIndexing.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,18 +202,16 @@ Basic indexing is triggered whenever a tuple of: integer, `slice`, `numpy.newaxi


<div class="alert alert-info">



**Reading Comprehension: Ellipsis**

Given a $N$-dimensional array, `x`, index into `x` such that you access entry-0 of axis-0, the last entry of axis-$N-1$, slicing along all intermediate dimensions. $N$ is at least $2$.

</div>


<div class="alert alert-info">

<!-- #region -->
<div class="alert alert-info">

**Reading Comprehension: Basic Indexing**

Given a shape-(4, 3) array,
Expand Down Expand Up @@ -291,9 +289,9 @@ False
Thus updating a variable `subarray` via `subarray = subarray + 2` does *not* overwrite the original data referenced by `subarray`. Rather, `subarray + 2` assigns that new array to the variable `subarray`. NumPy does provide mechanisms for performing mathematical operations to directly update the underlying data of an array without having to create a distinct array. We will discuss these mechanisms in the next subsection.
<!-- #endregion -->

<div class="alert alert-info">

<!-- #region -->
<div class="alert alert-info">

**Reading Comprehension: Views**

Given,
Expand Down
16 changes: 15 additions & 1 deletion Python/changes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,20 @@ Changelog
This is a record of all past PLYMI releases and what went into them,
in reverse chronological order.

----------
2021-01-31
----------

Upgrades the tools used to build PLYMI:

- sphinx 3.4.3
- nbsphinx 0.8.1
- jupytext 1.9.1
- sphinx-rtd-theme 0.5.1

Adds a reading comprehension problem in `the section on type-hinting <https://www.pythonlikeyoumeanit.com/Module5_OddsAndEnds/Writing_Good_Code.html#Type-Hinting>`_
to show that ``jedi`` provides annotation-informed autocompletion abilities in notebooks.


----------
2021-01-30
Expand All @@ -13,7 +27,7 @@ in reverse chronological order.
Updated the discussion of `computing pairwise differences <https://www.pythonlikeyoumeanit.com/Module3_IntroducingNumpy/Broadcasting.html#An-Advanced-Application-of-Broadcasting:-Pairwise-Distances>`_
to account for potential floating-point edge cases that can produce "NaNs" as a result.

There is currently an incompatibility between `jedi 0.18.0` and IPython, which breaks autocompletion. See `here <https://github.com/ipython/ipython/issues/12740>`_ for more details.
There is currently an incompatibility between ``jedi 0.18.0`` and IPython, which breaks autocompletion. See `here <https://github.com/ipython/ipython/issues/12740>`_ for more details.
Added temporary callout boxes to the `informal introduction to Python <https://www.pythonlikeyoumeanit.com/Module1_GettingStartedWithPython/Informal_Intro_Python.html>`_ and to
the `introduction to Jupyter notebooks <https://www.pythonlikeyoumeanit.com/Module1_GettingStartedWithPython/Jupyter_Notebooks.html>`_, which instruct readers to remedy this by downgrading jedi.

Expand Down
29 changes: 23 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,19 +31,36 @@ If you want to submit a change to some of the content (e.g. correcting typos), d
# Building the Site
**Important Note: it is strongly preferred that pull requests *do not* contain changes to the HTML of this site. Rather, it is better if PRs simply contain changes to text files (.rst or .md). A site administrator (@rsokl, @davidmascharka) will be responsible for publishing the actual site-HTML**. Thus the following instructions are useful for you to view your changes as they will appear in the site, but you likely need not go through the process of committing the changes to the HTML.

First, clone this repository.
## Creating a Conda Environment From Scratch

You will need to have [anaconda installed](https://www.pythonlikeyoumeanit.com/Module1_GettingStartedWithPython/Installing_Python.html) on your computer. Then create a new conda environment using the yaml file, `plymi.yml`, that is located at the top-level of this repository. To create the `plymi` conda environment, run:
First, create a miniconda environment. We'll call it `plymi` and will use Python 3.8

```shell
conda env create -f plymi.yml
conda create -n plymi python=3.8
```

Once this environment is created activate it. You may need to manually install a couple of dependencies (check if these are installed in your environment first):
It is important that we activate the environment before proceeding

```shell
pip install sphinx-rtd-theme==0.4.3
pip install jupytext==1.9.1
conda activate plymi
```

Next, we will install ipython, Jupyter, numpy, and matplotlib

```shell
conda install ipython jupyter notebook numpy matplotlib
```

Next, we'll use the `conda-forge` package channel to install some critical packages for building the HTML

```shell
conda install -c conda-forge sphinx==3.4.3 nbsphinx==0.8.1 pandoc==2.1.3 jupytext=1.9.1 nbformat=5.0.8
```

Finally, we will use PyPi to install jupytext and our website's stylistic theme

```shell
pip install sphinx-rtd-theme==0.5.1
```

and install the `plymi` code base from this repo. Clone the present repository and run:
Expand Down
2 changes: 1 addition & 1 deletion docs/.buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: a953f77103ab9e57635615a0e47efcda
config: 30bed98bcfc3f0fafb4c6590d4dc316d
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/Module2_EssentialsOfPython/Basic_Objects.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/Module2_EssentialsOfPython/DataStructures.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/Module2_EssentialsOfPython/ForLoops.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module2_EssentialsOfPython/Functions.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/Module2_EssentialsOfPython/Introduction.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module2_EssentialsOfPython/Iterables.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module2_EssentialsOfPython/Itertools.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/Module2_EssentialsOfPython/Scope.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module2_EssentialsOfPython/SequenceTypes.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/Module3_IntroducingNumpy/AdvancedIndexing.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module3_IntroducingNumpy/ArrayTraversal.doctree
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/Module3_IntroducingNumpy/BasicIndexing.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module3_IntroducingNumpy/Broadcasting.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified docs/.doctrees/Module4_OOP/Applications_of_OOP.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module4_OOP/Brief_Review.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module4_OOP/ClassDefinition.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module4_OOP/ClassInstances.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module4_OOP/Inheritance.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module4_OOP/Introduction_to_OOP.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module4_OOP/Methods.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module4_OOP/ObjectOrientedProgramming.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module4_OOP/Special_Methods.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module5_OddsAndEnds/Matplotlib.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module5_OddsAndEnds/Modules_and_Packages.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module5_OddsAndEnds/WorkingWithFiles.doctree
Binary file not shown.
Binary file modified docs/.doctrees/Module5_OddsAndEnds/Writing_Good_Code.doctree
Binary file not shown.
Binary file modified docs/.doctrees/changes.doctree
Binary file not shown.
Binary file modified docs/.doctrees/environment.pickle
Binary file not shown.
Binary file modified docs/.doctrees/index.doctree
Binary file not shown.
Binary file modified docs/.doctrees/intro.doctree
Binary file not shown.
Binary file modified docs/.doctrees/module_1.doctree
Binary file not shown.
Binary file modified docs/.doctrees/module_2.doctree
Binary file not shown.
Binary file modified docs/.doctrees/module_2_problems.doctree
Binary file not shown.
Binary file modified docs/.doctrees/module_3.doctree
Binary file not shown.
Binary file modified docs/.doctrees/module_3_problems.doctree
Binary file not shown.
Binary file modified docs/.doctrees/module_4.doctree
Binary file not shown.
Binary file modified docs/.doctrees/module_5.doctree
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -233,7 +233,7 @@
"extension": ".md",
"format_name": "markdown",
"format_version": "1.2",
"jupytext_version": "1.3.0rc1"
"jupytext_version": "1.9.1"
}
},
"kernelspec": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
"extension": ".md",
"format_name": "markdown",
"format_version": "1.2",
"jupytext_version": "1.3.0rc1"
"jupytext_version": "1.9.1"
}
},
"kernelspec": {
Expand Down
Loading