Skip to content

Commit 42d8a62

Browse files
committed
Update Tutorials to Markdown Format
1 parent 541f38d commit 42d8a62

File tree

1 file changed

+18
-19
lines changed

1 file changed

+18
-19
lines changed

readme.md

+18-19
Original file line numberDiff line numberDiff line change
@@ -4,42 +4,41 @@ This GitHub repository contains a number of beginner friendly Python tutorials c
44

55
Please star and share this repository if you've found it useful as it will make it easier for others to find.
66

7-
## Viewing Markdown Files
7+
These tutorials are in markdown format and GitHub displays the markdown as a webpage. Note some of the guides are screenshot intensive and on slow connections, the browser may timeout before all the images are downloaded. The browser caches downloaded images, refresh the page a couple of times to allow the browser to download the remaining images and the page should display correctly. The GitHub repository can also be downloaded and the readme.md can be opened in VSCode. Some of the styling in the markdown tables that are ignored on GitHub will render better in VSCode. This styling more closely resembles the Variable Explorer of the Spyder IDE.
88

9-
These tutorials are in markdown format and GitHub displays the markdown as a webpage. Note some of the guides are screenshot intensive. On slow connections, the browser may timeout before all the images are downloaded. Downloaded images will be cached, refresh the page a couple of times to will continue downloading the remaining images.
9+
## Development Environment Setup
1010

11-
The GitHub repository can also be downloaded and the readme.md can be opened in VSCode. Some of the styling in the markdown tables that are ignored on GitHub will render better in VSCode. This styling more closely resembles the Variable Explorer of the Spyder IDE.
11+
Python has a large number of development environments. Beginners often have problems setting up a Python environment because they use the basic installer from Python.org which only contains a very basic IDE, called IDLE. They then attempt to follow tutorials, often with a conda-based distribution such as Anaconda and end up messing up their Anaconda base (conda) Python environment because they attempt to add community channel packages to the commercial distribution which is designed to be used "as is". These setup tutorials are a bit more detailed and should familarise the user with the conda package manager examining the structure of a (conda) Python environment in the operating systems file explorer.
1212

13-
### Windows
14-
15-
* [Cloning a GitHub Repository and Viewing Markdown in VSCode](./github_install_windows/readme.md)
16-
17-
### Ubuntu
13+
The following guides covers installation and basic use of the:
1814

19-
The Ubuntu instructions can be modified slightly for another Linux distribution and should closely resemble installation on a Mac:
15+
* **S**cientific **Py**thon **D**evelopment **E**nvi**r**onment (Spyder).
16+
* JupyterLab (**Ju**lia, **Pyt**hon **e**t **R** **Lab**oratory)
17+
* VSCode (**V**isual **S**tudio **Code**)
2018

21-
* [Cloning a GitHub Repository and Viewing Markdown in VSCode](./github_install_ubuntu/readme.md)
19+
Spyder is tailored for scientists and engineers and has the most commonly used packages from the scientific stack preinstalled, a conda environment can be used to install additional packages. This makes it very beginner friendly. This installation guide will also cover installation of additional packages using Miniforge to create a `conda-forge` (community channel) environment. Additional dependencies such as TeX (commonly used in plots), which do not have a `conda-forge` package.
2220

23-
## Installation
21+
JupyterLab is installed via a separate `conda-forge` (community channel) environment and is a browser-based IDE which is based around the interactive python notebook.
2422

25-
The following guide covers installation and basic use of the **S**cientific **Py**thon **D**evelopment **E**nvi**r**onment (Spyder). Spyder is tailored for scientists and engineers and has the most commonly used packages from the scientific stack preinstalled. This makes it very begineer friendly.
23+
VSCode is a general purpose code editor and can be used with Python, when the Python related extensions are installed and a separate `conda-forge` (community channel) environment is selected as the Python interpreter and initialised with the Terminal. Beginners often struggle to get started with VScode, because they do not perform a perquisite step incorrectly or miss a perquisite step out entirely.
2624

27-
This installation guide will also cover installation of additional packages using Miniconda to create a `conda-forge` (community channel) environment and additional dependencies such as TeX (commonly used in plots), which do not have a `conda-forge` package.
25+
Preference of a specific Python IDE is somewhat subjective and I routinely use the 3 IDEs above for different purposes. These markdown tutorials can be used with any of the above 3 IDEs or another IDE that has an ipython console. As there are significant differences between Windows and Ubuntu, installation tutorials will be listed for each Operating System:
2826

2927
### Windows
3028

31-
* [Spyder Setup](./spyder_install_windows/readme.md)
29+
* [GitHub Desktop Setup + Cloning this Repository](./github_install_windows/readme.md)
30+
* [Spyder Setup + Miniforge Setup + TeX Setup](./spyder_install_windows/readme.md)
31+
* [JupyterLab Setup](/jupyter_install_windows/readme.md)
32+
* VSCode Setup
3233

3334
### Ubuntu
3435

3536
The Ubuntu instructions can be modified slightly for another Linux distribution and should closely resemble installation on a Mac:
3637

37-
* [Spyder Setup](./spyder_install_ubuntu/readme.md)
38-
39-
Preference of IDE is somewhat subjective. The remaining tutorials are in markdown format, and can be used in any other Python IDE that has an ipython console such as JupyterLab and VSCode (when VSCode is configured for Python).
40-
38+
* [GitHub Desktop Setup + Cloning this Repository](./github_install_ubuntu/readme.md)
39+
* [Spyder Setup + Miniforge Setup + Tex Setup](./spyder_install_ubuntu/readme.md)
4140
* [JupyterLab Setup](./jupyter_install_ubuntu/readme.md)
42-
41+
* [VSCode Setup](./vscode_install_ubuntu/readme.md)
4342

4443
## Python and Standard Libraries
4544

0 commit comments

Comments
 (0)