Skip to content

Commit 18b0668

Browse files
committed
Fix typos and formatting, add some links
1 parent 0e7cd88 commit 18b0668

File tree

6 files changed

+43
-17
lines changed

6 files changed

+43
-17
lines changed

_toc.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
- file: foundations/overview
1414
- file: foundations/getting-started-python/getting-started-python
1515
sections:
16-
- file: foundationsgetting-started-python/why-python
16+
- file: foundations/getting-started-python/why-python
1717
sections:
1818
- file: foundations/getting-started-python/Hello
1919
- file: foundations/getting-started-python/how-to-run-python

foundations/getting-started-python/conda.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,19 @@ Package management is useful because you may want to update a package for one of
1010

1111
## Installing Conda
1212

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

1515
Miniconda is a paired down version of Anaconda. [Installing Anaconda](https://docs.anaconda.com/anaconda/install/) takes longer and takes up more disk space, but provides you with more functionality. Anaconda comes with a Jupyter and Spyder, a Python-specific integrated development platform (IDE), installations as well as other packages. The interface of Anaconda is great if you are uncomfortable with the terminal.
1616

17+
_Elaborate on Miniconda vs Anaconda... Miniconda is recommended because we should install packages in isolated environments..._
18+
1719
## Creating a Conda environment
1820

19-
A conda environment is a directory that contains a collection of packages or libraries that you would like installed and accessible for this workflow. 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, type `conda create --name sample_environment python jupyterlab`.
21+
A conda environment is a directory that contains a collection of packages or libraries that you would like installed and accessible for this workflow. 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
22+
23+
```
24+
conda create --name sample_environment python jupyterlab
25+
```
2026

2127
It is a good idea to create new environments for different projects because since Python is open source, new versions of the tools you use may become available. This is a way of guaranteeing that your script will use the same versions of packages and libraries and should run the same as you expect it to.
2228

foundations/getting-started-python/how-to-run-python.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This section provides an overview of different ways to run Python code, and quickstart guides for
44

5-
- Chosing a Python platform
5+
- Choosing a Python platform
66
- Installing and running Python on various local platforms
77
- Running Python in the cloud
88

@@ -13,24 +13,25 @@ There is no single official platform for the Python language. Here we provide a
1313
1. The terminal,
1414
2. Jupyter notebooks, and
1515
3. IDEs (integrated development environment).
16-
We highly encourage the use of Jupyter notebooks; all of our tutorials will be in a Jupyter notebook format. Here we hope to provide you with enough information to understand the differences and similarities between each platform so that you can make the best chose for your work environment and learn along effectively, regardless of your Python platform preference.
1716

18-
In general, it is always best to test your programs in the same environment in which they will be run. The biggest factors to consider when chosing your platform are:
17+
We highly encourage the use of Jupyter notebooks; all of our tutorials will be in a Jupyter notebook format. Here we hope to provide you with enough information to understand the differences and similarities between each platform so that you can make the best chose for your work environment and learn along effectively, regardless of your Python platform preference.
18+
19+
In general, it is always best to test your programs in the same environment in which they will be run. The biggest factors to consider when choosing your platform are:
1920

2021
- What are you already comfortable with?
2122
- What are the people around you using (peers, coworkers, instructors, etc)?
2223

2324
### Terminal
2425

25-
For learners who are familiar with basic [Linix commands](https://cheatography.com/davechild/cheat-sheets/linux-command-line/).and text editors, learning Python in the terminal is the quickest route straight to learning Python syntax without the covering the bells and whistles of your new platform. If you are runing Python on a super computer, through an HTTP request, or ssh tunneling you might want to consider learning in the terminal.
26+
For learners who are familiar with basic [Linux commands](https://cheatography.com/davechild/cheat-sheets/linux-command-line/).and text editors, learning Python in the terminal is the quickest route straight to learning Python syntax without the covering the bells and whistles of your new platform. If you are runing Python on a super computer, through an HTTP request, or ssh tunneling you might want to consider learning in the terminal.
2627

2728
### Jupyter Session
2829

2930
Jupyter Notebooks are very popular among data scientists. It is a free, open-source, interactive tool that allows you to run Python code in "cells." This means that your workflow can alternate between code, output, and even Markdown-formatted explanatory sections that create an easy to follow analysis from start to finish. Jupyter notebooks are a great option for presentations or learning tools. For these reasons the lessons in this book will be taught via Jupyter notebooks.
3031

3132
### Other IDEs
3233

33-
If you already code in other languages you might already have a favorite IDE that will work just as well in Python. Spyder is a Python specific IDE that comes with the Anaconda download. It is perhaps the most familiar IDE if you are coming from languages such as Matlab that have a language specific platform and display a list of variables. PyCharm and Visual Studio Code are also popular IDEs. Many IDEs offer support for terminal execution, scripts, and Jupyter display. To learn about your specific IDE visit its official documentation.
34+
If you already code in other languages you might already have a favorite IDE that will work just as well in Python. [Spyder](https://www.spyder-ide.org) is a Python specific IDE that comes with the [Anaconda download](https://www.anaconda.com/products/individual). It is perhaps the most familiar IDE if you are coming from languages such as [Matlab](https://www.mathworks.com/products/matlab.html) that have a language specific platform and display a list of variables. [PyCharm](https://www.jetbrains.com/pycharm/) and [Visual Studio Code](https://code.visualstudio.com) are also popular IDEs. Many IDEs offer support for terminal execution, scripts, and Jupyter display. To learn about your specific IDE visit its official documentation.
3435

3536
---
3637

foundations/getting-started-python/jupyter.md

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,24 @@ To run a Jupyter session you will need to install some necessary packages into y
1111
You can install `miniconda`. You can do that by following the [instructions for you machine](https://docs.conda.io/en/latest/miniconda.html).
1212

1313
Then create a Conda environment with Python installed.
14-
`conda create --name pythia_foundations python jupyterlab nb_conda_kernels`
14+
15+
```
16+
conda create --name pythia_foundations python jupyterlab nb_conda_kernels
17+
```
1518

1619
Or you can install the full [Anaconda](https://www.anaconda.com/products/individual), and select Jupyter in the GUI. **have a screenshot of that here**
1720

18-
Test that you have installed everything correctly by activating your environment with `conda activate pythia_foundations` and running `jupyter lab`.
21+
Test that you have installed everything correctly by first activating your environment:
22+
23+
```
24+
conda activate pythia_foundations
25+
jupyter lab
26+
```
27+
28+
A new window should open automatically in your default browser. You can change the browser with (for example):
1929

20-
A new window should open automatically in your default browser. You can change the browser with `jupyter lab —browser=chrome`.
30+
```
31+
jupyter lab —browser=chrome
32+
```
2133

2234
## Running Python in Jupyter

foundations/getting-started-python/terminal.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,10 @@ You'd like to learn Python in the terminal. Here we will cover:
1010
If running Python in the terminal it is best to install Miniconda. You can do that by following the [instructions for you machine](https://docs.conda.io/en/latest/miniconda.html).
1111

1212
Then create a Conda environment with Python installed by typing the following into your terminal:
13-
`conda create --name pythia_foundations python`
13+
14+
```
15+
conda create --name pythia_foundations python
16+
```
1417

1518
You can test that this by running `python` in the command line.
1619

foundations/getting-started-python/why-python.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,20 @@
22

33
You're already here because you want to learn to use Python for your data analysis and visualizations. Python can be compared to other high-level, interpreted, object-oriented languages, but is especially great because it is free and open source!
44

5-
**High level languages:**
5+
## High level languages
6+
67
Other high level languages include MatLab, IDL, and NCL. The advantage of high level languages is that the provide functions, data structures, and other utilities that are commonly used, which means it takes less code to get real work done. The disadvantage of high level languages is that they tend to obscure the low level aspects of the machine such as: memory use, how many floating point operations are happening, and other information related to performance. C and C++ are all examples of lower level languages. The "higher" the level of language, the more computing fundamentals are abstracted.
78

8-
**Interpreted languages:**
9-
Most of your work is probably already in interpreted languages if you've ever used IDL, NCL, or MatLab (interpreted languages are typically also high level). So you are already familiar with the advantages of this: you don't have to worry about compiling or machine compatability (it is portable). And you are probably familiar with their deficiencies: sometimes they can be slower than compiled languages and potentially more memory intensive.
9+
## Interpreted languages
10+
11+
Most of your work is probably already in interpreted languages if you've ever used IDL, NCL, or MatLab (interpreted languages are typically also high level). So you are already familiar with the advantages of this: you don't have to worry about compiling or machine compatibility (it is portable). And you are probably familiar with their deficiencies: sometimes they can be slower than compiled languages and potentially more memory intensive.
12+
13+
## Object Oriented languages
1014

11-
**Object Oriented languages:**
1215
Objects are custom datatypes. For every custom datatype, you usually have a set of operations you might want to conduct. For example, if you have an object that is a list of numbers you might want to apply a mathematical operation, such as sum, onto this list object in bulk. Not every function can be applied to every datatype; it wouldn't make sense to apply a logarithm to a string of letters or to capitalize a list of numbers. Data and the operations applied to them are grouped together into one object.
1316

14-
**Open source:**
17+
## Open source
18+
1519
Python as a language is open source which means that there is a community of developers behind its codebase. Anyone can join the developer community and contribute to deciding the future of the language. When someone identifies gaps to Python's abilities, they can write up the code to fill these gaps. The open source nature of Python means that Python as a language is very adaptable to shifting needs of the user community.
1620

1721
Python is a language designed for rapid prototyping and efficient programming. It is easy to write new code quickly with less typing.

0 commit comments

Comments
 (0)