Skip to content

Commit 35111ce

Browse files
jnmorleyJames Morleypre-commit-ci[bot]jukentdopplershift
authored
Fix typos (#372)
* fixed typos in foundations/jupyter.md * fixed typos in foundations/conda.md * fixed typos in foundations/getting-started-jupyter.ipynb * fixed spelling and grammar in foundations/jupyterlab.ipynb * removed 'Jupyter Lab' text from binder-highlight.png * fixed grammar in foundations/markdown.md * added comma to getting-started-github.md * fixed typos listed is excel sheet mentioned in issue 337 * [pre-commit.ci] auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * added replacement text from google doc * Update foundations/github/github-issues.md Co-authored-by: Ryan May <rmay31@gmail.com> * Update foundations/conda.md Co-authored-by: Ryan May <rmay31@gmail.com> * Update foundations/github/github-repos.md Co-authored-by: Ryan May <rmay31@gmail.com> * deleted far_left_cell.png image as it is no longer used --------- Co-authored-by: James Morley <jmorley@ucar.edu> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com> Co-authored-by: Julia Kent <46687291+jukent@users.noreply.github.com> Co-authored-by: Ryan May <rmay31@gmail.com>
1 parent 6d8d402 commit 35111ce

13 files changed

+130
-134
lines changed

foundations/conda.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -25,17 +25,17 @@ Here we will cover:
2525

2626
## What are Packages?
2727

28-
A Python package is a collection of modules, which in turn, are essentially Python scripts that contain published functionality. There are Python packages for data input, data analysis, data visualization, etc. Each package offers a unique toolset and may have its own unique syntax rules.
28+
A Python package is a collection of modules, which, in turn, are essentially Python scripts that contain published functionality. There are Python packages for data input, data analysis, data visualization, etc. Each package offers a unique toolset and may have its own unique syntax rules.
2929

3030
Package management is useful because you may want to update a package for one of your projects, but keep it at the same version in other projects to ensure that they continue to run as expected.
3131

3232
## Installing Conda
3333

34-
We recommend you install Miniconda. You can do that by following the [instructions for you machine](https://docs.conda.io/en/latest/miniconda.html).
34+
We recommend you install Miniconda. You can do that by following the [instructions for your machine](https://docs.conda.io/en/latest/miniconda.html).
3535

3636
Miniconda only comes with the `conda` package management system; it is a pared-down version of the full Anaconda Python distribution.
3737

38-
[Installing Anaconda](https://docs.anaconda.com/anaconda/install/) takes longer and takes up more disk space, but provides you with more functionality: Jupyter, Spyder (a Python-specific integrated development platform or IDE), as well as other immediately installed packages. The interface of Anaconda is great if you are uncomfortable with the terminal.
38+
[Installing Anaconda](https://docs.anaconda.com/anaconda/install/) takes longer and uses up more disk space, but provides you with more functionality, including Spyder (a Python-specific integrated development environment or IDE) and Jupyter, in addition to other immediately installed packages. Also, the interface of Anaconda is great if you are uncomfortable with the terminal.
3939

4040
We recommend Miniconda for two reasons:
4141

@@ -46,17 +46,17 @@ Once you have `conda` via the Miniconda installer, the next step is to create an
4646

4747
## Creating a Conda Environment
4848

49-
A conda environment is an interoperable collection of specific versions of packages or libraries that you install and use for a specific workflow. The conda package manager takes care of dependencies so everything works together in a predictable way. One huge advantage of using environments is that any changes you make to one environment will not affect your other environments at all, so you are much less likely to "break" something!
49+
A Conda environment is an interoperable collection of specific versions of packages or libraries that you install and use for a specific workflow. The Conda package manager takes care of dependencies, so everything works together in a predictable way. One huge advantage of using environments is that any changes you make to one environment will not affect your other environments at all, so you are much less likely to "break" something!
5050

5151
To create a new Conda environment, type `conda create --name` and the name of your environment in your terminal, and then specify any packages that you would like to have installed. For example, to install a Jupyter-ready environment called `sample_environment`, type
5252

5353
```
5454
conda create --name sample_environment python jupyterlab
5555
```
5656

57-
Once the environment is created, you need to _activate_ it in the current terminal session (see below)
57+
Once the environment is created, you need to _activate_ it in the current terminal session (see below).
5858

59-
It is a good idea to create new environments for different projects because since Python is open source, new versions of the tools are released very frequently. Isolated environments help guarantee that your script will use the same versions of packages and libraries and should run the same as you expect it to. Similarly, it is best practice to NOT modify your `base` environment.
59+
It is a good idea to create a new environment for every project. Because Python is open source, new versions of the tools are released frequently. Isolated environments help guarantee that your scripts use the same versions of packages and libraries to ensure they run as expected. Similarly, it is best practice to NOT modify your `base` environment.
6060

6161
## Useful Conda commands
6262

@@ -80,13 +80,13 @@ conda deactivate
8080
conda list
8181
```
8282

83-
- Installing a new package into current environment
83+
- Installing a new package into the current environment
8484

8585
```
8686
conda install somepackage
8787
```
8888

89-
- Installing a specific version of a package into current environment
89+
- Installing a specific version of a package into the current environment
9090

9191
```
9292
conda install somepackage=0.17
@@ -110,15 +110,15 @@ conda env list
110110
conda env remove --name sample_environment
111111
```
112112

113-
Lots more information is in the [conda documentation](https://docs.conda.io/) or this handy [conda cheat sheet](https://docs.conda.io/projects/conda/en/latest/_downloads/843d9e0198f2a193a3484886fa28163c/conda-cheatsheet.pdf)
113+
You can find lots more information in the [Conda documentation](https://docs.conda.io/en/latest/) or this handy [Conda cheat sheet](https://docs.conda.io/projects/conda/en/latest/_downloads/843d9e0198f2a193a3484886fa28163c/conda-cheatsheet.pdf).
114114

115115
If you're not a command line user, the Anaconda navigator offers GUI functionality for selecting environments and installing packages.
116116

117117
---
118118

119119
## Summary
120120

121-
Conda is a package and environment management system that allows you to quickly install, run, and update packages within your work environment(s). This is important for gathering all of the tools necessary for your workflow. Conda can be managed in the command line or in the Anacond GUI.
121+
Conda is a package and environment management system that allows you to quickly install, run, and update packages within your work environment(s). This is important for gathering all of the tools necessary for your workflow. Conda can be managed in the command line or in the Anaconda GUI.
122122

123123
### What's Next?
124124

@@ -128,7 +128,7 @@ Conda is a package and environment management system that allows you to quickly
128128
## Resources and References
129129

130130
- [Linux commands](https://cheatography.com/davechild/cheat-sheets/linux-command-line/)
131-
- [conda documentation](https://docs.conda.io/)
132-
- [conda cheat sheet](https://docs.conda.io/projects/conda/en/latest/_downloads/843d9e0198f2a193a3484886fa28163c/conda-cheatsheet.pdf)
131+
- [Conda documentation](https://docs.conda.io/en/latest/)
132+
- [Conda cheat sheet](https://docs.conda.io/projects/conda/en/latest/_downloads/843d9e0198f2a193a3484886fa28163c/conda-cheatsheet.pdf)
133133
- [Anaconda](https://docs.anaconda.com/anaconda/install/)
134134
- [Miniconda](https://docs.conda.io/en/latest/miniconda.html)

foundations/getting-started-github.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ We will walk users through these topics:
1515
- [What are GitHub Repositories](github/github-repos), and what are some Python-specific examples?
1616
- [Issues and Discussions](github/github-issues) on GitHub: what they're for and how to participate
1717
- [Cloning and Forking a Repository](github/github-cloning-forking) (and what's the difference?)
18-
- [Detailed GitHub Configuration](github/github-setup-advanced) including how to set up secure permissions and notifications
18+
- [Detailed GitHub Configuration](github/github-setup-advanced), including how to set up secure permissions and notifications
1919
- [Basic Version Control with _git_](github/basic-git): why you may need it, and how to get started
2020
- [What is a git _Branch_?](github/git-branches)
2121
- [What's a Pull Request](github/github-pull-request), and how do you open one?

foundations/getting-started-jupyter.ipynb

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@
7575
"source": [
7676
"## Jupyter Notebooks\n",
7777
"\n",
78-
"The Jupyter Notebook is an open-source web application that allows you to create and share Jupyter notebooks (*ipynb files). Jupyter Notebooks contain executable code, LaTeX equations, visualizations (e.g., plots, pictures), and narrative text. The code does not have to just be Python, other languages such as Julia or R are supported as well. \n",
78+
"The Jupyter Notebook software is an open-source web application that allows you to create and share Jupyter Notebooks (*.ipynb files). Jupyter Notebooks contain executable code, LaTeX equations, visualizations (e.g., plots, pictures), and narrative text. The code does not have to just be Python, other languages such as Julia or R are supported as well. \n",
7979
"\n",
8080
"Jupyter Notebooks are celebrated for their interactive output that allows movement between code, code output, explanations, and more code - similar to how scientists think and solve problems. Jupyter Notebooks can be thought of as a living, runnable publication and make for a great presentation platform."
8181
]
@@ -100,7 +100,7 @@
100100
"\n",
101101
"A popular web application on which users can create and write their Jupyter Notebooks, as well as explore data, install software, etc.\n",
102102
"\n",
103-
"More information on running Jupyter Lab [here](jupyterlab)."
103+
"You can find more information on running Jupyter Lab [here](jupyterlab)."
104104
]
105105
},
106106
{
@@ -130,9 +130,9 @@
130130
"source": [
131131
"### Local Execution Model\n",
132132
"\n",
133-
"You can launch JupyterLab from a terminal, it will open up in a web browser. The application is running on the browser. When you open a notebook, Jupyter opens a kernel which can be tied to a specific coding language.\n",
133+
"You can launch JupyterLab from a terminal; it will open up in a web browser. The application will then be running in that web browser. When you open a notebook, Jupyter opens a kernel which can be tied to a specific coding language.\n",
134134
"\n",
135-
"To launch the JupyterLab interface in your browser follow the instructions in [Installing and Running Python: Python in Jupyter](https://foundations.projectpythia.org/foundations/jupyter.html).\n",
135+
"To launch the JupyterLab interface in your browser, follow the instructions in [Installing and Running Python: Python in Jupyter](https://foundations.projectpythia.org/foundations/jupyter.html).\n",
136136
"\n",
137137
"![Local Execution Model](../images/local-execution-model.gif)"
138138
]
@@ -145,7 +145,7 @@
145145
"source": [
146146
"### Remote Execution Model\n",
147147
"\n",
148-
"In the remote execution model you start out in the browser, navigate to a specific URL that points to a JupyterHub. On JupyterHub you authenticate on the remote system, and then JupyterLab is launched and redirected back to your browser. The interface appears the same as if you were running Jupyter locally.\n",
148+
"In the remote execution model, you start out in the browser, then navigate to a specific URL that points to a JupyterHub. On JupyterHub, you authenticate on the remote system, and then JupyterLab is launched and redirected back to your browser. The interface appears the same as if you were running Jupyter locally.\n",
149149
"\n",
150150
"![Remote Execution Model](../images/remote-execution-model.gif)"
151151
]
@@ -168,7 +168,7 @@
168168
"## Summary\n",
169169
"\n",
170170
"Jupyter consists of four main components:\n",
171-
"- Jupyter Notebooks (the \".ipynb\" files),\n",
171+
"- Jupyter Notebooks (the \"*.ipynb\" files),\n",
172172
"- Jupyter Kernels (the work environment),\n",
173173
"- Jupyter Lab (a popular web application and interface for local execution),\n",
174174
"- and Jupyter Hub (an application and launcher for remote execution).\n",
@@ -212,7 +212,7 @@
212212
"name": "python",
213213
"nbconvert_exporter": "python",
214214
"pygments_lexer": "ipython3",
215-
"version": "3.10.4"
215+
"version": "3.10.8"
216216
},
217217
"nbdime-conflicts": {
218218
"local_diff": [

0 commit comments

Comments
 (0)