summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorChristian Kolset <christian.kolset@gmail.com>2025-02-05 12:16:42 -0700
committerChristian Kolset <christian.kolset@gmail.com>2025-02-05 12:16:42 -0700
commit9c2e0d2d6d4a59b1a8cc34a98e416f97f67364df (patch)
tree21e220973f98def2e38572a29647babcf131bedc
parent98f45d4781b2123ca3cc11245282c6353d1c2be6 (diff)
restructured tutorial/readme.md to reflect course overview
-rw-r--r--tutorials/1.1_installing_anaconda.md6
-rw-r--r--tutorials/1.2_intro_to_anaconda.md12
-rw-r--r--tutorials/2.1_spyder_getting_started.md9
-rw-r--r--tutorials/3.1_basics_of_python.md3
-rw-r--r--tutorials/3.x_Classes_and_Objects.md3
-rw-r--r--tutorials/3.x_arrays.md20
-rw-r--r--tutorials/control_structures.md5
-rw-r--r--tutorials/intro_to_numerical_methods.md6
-rw-r--r--tutorials/open_source_software.md4
-rw-r--r--tutorials/plotting.md3
-rw-r--r--tutorials/readme.md46
11 files changed, 80 insertions, 37 deletions
diff --git a/tutorials/1.1_installing_anaconda.md b/tutorials/1.1_installing_anaconda.md
index 807fbed..5a2e63e 100644
--- a/tutorials/1.1_installing_anaconda.md
+++ b/tutorials/1.1_installing_anaconda.md
@@ -3,7 +3,7 @@
This tutorial walk will walk through how to install Anaconda Navigator.
### What is Anaconda?
-Anaconda is an open source data science and artificial intelligence distribution platform for Python and R programing language. -Wikipedia
+<quote> Anaconda is an open source data science and artificial intelligence distribution platform for Python and R programing language. -Wikipedia </quote>
### What is Navigator?
Anaconda Navigator is a desktop graphical user interface (GUI) inluded in Anaconda distribution that allows users to launch application and manage Conda Packages, environments and channels without using a command-line interface (CLI). -Wikipedia
@@ -51,7 +51,7 @@ Once the download is complete, double click the executible (.exe) file to start
Note: If you did not select start navigator after installation, you will need to go to you start menu and start Navigator from Applications list.
### Mac
-
+For Mac user
### Linux
-This
+Refer to your distribution's documentation on how to install Anaconda. For a ligt-weight installation. Miniconda and Spyder
diff --git a/tutorials/1.2_intro_to_anaconda.md b/tutorials/1.2_intro_to_anaconda.md
index ae52c17..f05cb4c 100644
--- a/tutorials/1.2_intro_to_anaconda.md
+++ b/tutorials/1.2_intro_to_anaconda.md
@@ -17,9 +17,9 @@ Once Navigator starts, under *Home*, you'll see tiles of programs that come with
The *Environment* page allows us to install a variety of libraries and configure our environments for different project, more on this in the next section.
## Environments
-A Python environment is like a "container" where you can have all the tools, libraries, and dependencies your Python project needs without interfering with other projects. Think of it as a toolbox dedicated to a specific task.
+A Python environment can be thought of as a "container" where you can have all the tools, libraries, and dependencies your Python project needs without interfering with other projects. Think of it as a toolbox dedicated to a specific task.
-Although the base environment comes with many libraries and programs pre-installed, it's recommended to create a dedicated environment for your projects. This protects the base environment from breaking due to complex dependency conflicts. Let us go ahead and create a new environment for us to use.
+Although the base environment comes with many libraries and programs pre-installed, it's recommended to create a dedicated environment for your projects. This protects the base environment from breaking due to complex dependency conflicts. Let us go ahead and create a new environment for us to use Spyder with.
1. Click on the *Environments* page located on the left hand side.
@@ -31,16 +31,16 @@ Although the base environment comes with many libraries and programs pre-install
3. Select the python checkbox.
-4. Select versions of python. For this tutorial we will be using version 3.XX.X.
+4. Select versions of python. At the time of making this tutorial the latest version of Python is 3.xx.x. We will go ahead and use that one.
-5. Choose an appropriate name for your project. We will be creating an environment for Spyder IDE so we'll call it "spyder-dev".
+5. Choose an appropriate name for your project. We will be creating an environment for the Spyder IDE so we'll call it "spyder-dev".
6. Click *Create*.
For more information see [Anaconda Environments](https://docs.anaconda.com/working-with-conda/environments/) and [Managing environment](https://docs.anaconda.com/navigator/tutorials/manage-environments/).
## Package Management
-Now that we have a clean environment let us install some library we will be using for this class.
+Now that we have a clean environment configured, let us install some library we will be using for this class.
1. Navigate to the environment page and select the environment we just created in the previous section.
@@ -56,3 +56,5 @@ Now that we have a clean environment let us install some library we will be usin
| matplotlib | Plots and visualizations |
| sympy | Symbolic mathematics |
| cython | Optimizing Python code and interfacing with C++ code |
+
+3. Once the
diff --git a/tutorials/2.1_spyder_getting_started.md b/tutorials/2.1_spyder_getting_started.md
index c247cf7..8a7f566 100644
--- a/tutorials/2.1_spyder_getting_started.md
+++ b/tutorials/2.1_spyder_getting_started.md
@@ -1,3 +1,10 @@
# Getting started with Spyder
-In this tutorial we will cover the basics of the Spyder IDE (Interactive Development Environment). If you've ever worked with MATLAB before, then this will feel familiar.
+In this tutorial we will cover the basics of the Spyder IDE (Interactive Development Environment). If you've ever worked with MATLAB before, then this will feel familiar. Spyder is a program
+
+
+## Launching Spyder
+Using Anaconda we will select the environment we created earlier.
+
+
+## Spyder Interface
diff --git a/tutorials/3.1_basics_of_python.md b/tutorials/3.1_basics_of_python.md
index 12762cd..abced24 100644
--- a/tutorials/3.1_basics_of_python.md
+++ b/tutorials/3.1_basics_of_python.md
@@ -1,4 +1,7 @@
# Basics of Python
+
+^88ce39
+
This page contains important fundamental concepts used in Python such as syntax, operators, order or precedence and more.
## Syntax
diff --git a/tutorials/3.x_Classes_and_Objects.md b/tutorials/3.x_Classes_and_Objects.md
index c25a14f..0392483 100644
--- a/tutorials/3.x_Classes_and_Objects.md
+++ b/tutorials/3.x_Classes_and_Objects.md
@@ -1,5 +1,6 @@
-# Classes and Objects
+# Modular Programming
+Classes and Objects
## What are they?
diff --git a/tutorials/3.x_arrays.md b/tutorials/3.x_arrays.md
index 57debfd..e698d67 100644
--- a/tutorials/3.x_arrays.md
+++ b/tutorials/3.x_arrays.md
@@ -1,5 +1,21 @@
# Arrays
+In computer programming, an array is a structure for storing and retrieving data. We often talk about an array as if it were a grid in space, with each cell storing one element of the data. For instance, if each element of the data were a number, we might visualize a “one-dimensional” array like a list:
+
+| 1 | 5 | 2 | 0 |
+
+A two-dimensional array would be like a table:
+
+| 1 | 5 | 2 | 0 |
+| 8 | 3 | 6 | 1 |
+| 1 | 7 | 2 | 9 |
+
+A three-dimensional array would be like a set of tables, perhaps stacked as though they were printed on separate pages.
+
+- From [Numpy documentation](https://numpy.org/doc/2.2/user/absolute_beginners.html)
+
+---
+
In this tutorial we will be introducing arrays and we will be using the numpy library. Arrays, lists, vectors, matrices, sets - You might've heard of them before, they all store data. In programming, an array is a variable that can hold more than one value at a time. We will be using the Numpy python library to create arrays.
Since we already have installed Numpy previously, we can start using the package.
@@ -9,8 +25,8 @@ When using packages in python, we need to let it know what package we will be us
```
import numpy as np
```
-<code> import numpy </code> specifies what library to import.
-<code> as np </code> gives the library an alias in your script. It's common convention in Python programming to make the code shorter and more readable. We will be using *np* as it's a standard using in many projects.
+<code> import </code> calls for a library to use, in our case it is Numpy.
+<code> as </code> gives the library an alias in your script. It's common convention in Python programming to make the code shorter and more readable. We will be using *np* as it's a standard using in many projects.
# Creating arrays
Now that the script has been
diff --git a/tutorials/control_structures.md b/tutorials/control_structures.md
new file mode 100644
index 0000000..345d94a
--- /dev/null
+++ b/tutorials/control_structures.md
@@ -0,0 +1,5 @@
+# Control Structers
+
+## If statements
+
+## Loops
diff --git a/tutorials/intro_to_numerical_methods.md b/tutorials/intro_to_numerical_methods.md
new file mode 100644
index 0000000..fd51953
--- /dev/null
+++ b/tutorials/intro_to_numerical_methods.md
@@ -0,0 +1,6 @@
+# Introduction to Numerical Methods
+
+
+## What is Numerical?
+
+## How does it work? [Error]
diff --git a/tutorials/open_source_software.md b/tutorials/open_source_software.md
new file mode 100644
index 0000000..0a10f27
--- /dev/null
+++ b/tutorials/open_source_software.md
@@ -0,0 +1,4 @@
+# Open Source Software
+
+
+## Licensing
diff --git a/tutorials/plotting.md b/tutorials/plotting.md
new file mode 100644
index 0000000..b309e2f
--- /dev/null
+++ b/tutorials/plotting.md
@@ -0,0 +1,3 @@
+# Plotting
+
+## matlibplot
diff --git a/tutorials/readme.md b/tutorials/readme.md
index d5eb431..d8f7f42 100644
--- a/tutorials/readme.md
+++ b/tutorials/readme.md
@@ -2,35 +2,31 @@
This directory contains all the tutorials.
## Table of Content
-
-### 1.0 Introduction to Anaconda
-- [1.1 installing_anaconda.md](1.1_installing_anaconda.md)
-- [1.2 intro_to_anaconda.md](1.2_intro_to_anaconda.md)
-- [1.3 version_control.md](1.3_version_control.md)
-
-- 1.x_open-source_software
-
-### 2.0 Spyder
-- [2.1 Getting started with Spyder](2.1_spyder_getting_started.md)
+### Introductory Programming Concepts
+- [Installing Anaconda](1.1_installing_anaconda.md)
+- [Intro to Anaconda](1.2_intro_to_anaconda.md)
+- [Getting started with Spyder](2.1_spyder_getting_started.md)
- [Fundamentals of Computing](fundamentals_of_programming.md)
--
-
-### 3.0 Programming in Python
-- [3.1 basics_of_python.md](3.1_basics_of_python.md)
-- [3.x_Arrays](3.x_arrays.md)[Numpy]
-- Plotting [Matplotlib]
-- Control Structures
- - Decisions/If conditions
- - Loops
-- [3.x_Functions](3.x_Functions.md)
-- [3.x_Classes/Objects](3.x_Classes_and_Objects.md)
+- [Open source_software](open_source_software.md)
+- [Basics of python](3.1_basics_of_python.md)
+- [Arrays](3.x_arrays.md)
+- [Control Structures](control_structures.md)
+- [Functions](3.x_Functions.md)
+- [Classes/Objects](3.x_Classes_and_Objects.md)
-### 4.0 Numerical Methods
-- Introduction to Numerical Methods
- - What is Numerical?
- - How does it work? [Error]
+### Algorithm Developments for ME
+- [Version Control](1.3_version_control.md)
+- [Introduction to Numerical Methods](intro_to_numerical_methods.md)
- Roots and Optimization
- Systems of Equations and LU Decomposition
- Linear Regression
- Numerical Integration
- Ordinary Differential Equations
+
+### Applications of Computational Mathematics in ME
+
+### Data Analysis of Processing
+- [Plotting](plotting.md)
+
+
+### Numerical Methods