Installation

Installation#

Note

This guide is under active maintenance. Changes to both dependencies and installation steps may occur.

This installation guide assumes you are using VSCode as your IDE. Some of you may encounter issues. Please consult the all-knowing web or your preferred ChatGPT-like AI before reaching out about your issue. Errors or bugs with the provided steps below are directed to Github.

Alternative 1 (best): Pixi#

  1. Install Pixi via this link here (https://pixi.prefix.dev/latest/installation/)

  2. Set up the course environment

    • Download the code handouts (TTK4130/code-handouts) repository to get the dependencies, or just download the dependency file here.

    • Navigate to the directory (folder) that contains the pixi.toml file, e.g. path/to/code-handouts/

    • Run pixi install to install all the dependencies in one command

  3. Install Visual Studio Code (VSCode) via the download page (https://code.visualstudio.com/download)

  4. Use Jupyter notebooks

    Option A: Command Line (easiest)

    • Run pixi run jupyter from the terminal (must be same folder as pixi.toml) to launch Jupyter notebook

    Option B: VSCode integration

  1. Install Pixi via this link here (https://pixi.prefix.dev/latest/installation/)

  2. Set up the course environment

    • Download the code handouts (TTK4130/code-handouts) repository to get the dependencies, or just download the dependency file here.

    • Navigate to the directory (folder) that contains the pixi.toml file, e.g. path/to/code-handouts/

    • Run pixi install to install all the dependencies in one command

  3. Install Visual Studio Code (VSCode) via the download page (https://code.visualstudio.com/download)

  4. Use Jupyter notebooks

    Option A: Command Line (easiest)

    • Run pixi run jupyter from the terminal (must be same folder as pixi.toml) to launch Jupyter notebook

    Option B: VSCode integration

  1. Install Pixi via this link here (https://pixi.prefix.dev/latest/installation/)

  2. Set up the course environment

    • Download the code handouts (TTK4130/code-handouts) repository to get the dependencies, or just download the dependency file here.

    • Navigate to the directory (folder) that contains the pixi.toml file, e.g. path/to/code-handouts/

    • Run pixi install to install all the dependencies in one command

  3. Install Visual Studio Code (VSCode) via the download page (https://code.visualstudio.com/download)

  4. Use Jupyter notebooks

    Option A: Command Line (easiest)

    • Run pixi run jupyter from the terminal (must be same folder as pixi.toml) to launch Jupyter notebook

    Option B: VSCode integration

Troubleshooting#

General tips:

  • Make sure you’re using the correct installer for your system architecture

  • Restart your terminal or VSCode after installation to make sure the changes take effect

Alternative 2 (old): Miniconda#

  1. Install Python using Miniconda via this download page

  2. Run the following three commands in a terminal or Anaconda prompt to update conda and create a conda environment

conda init
conda update -y conda
conda create -y --name ttk4130 python=3.11 sympy numpy scipy matplotlib ipython jupyter pythreejs -c conda-forge

  1. Install Visual Studio Code (VSCode) via the download page

  2. Start VSCode and activate your newly created Python environment, ttk4130 (See this guide on python environments)

  3. Install the following list of VSCode extensions (See this guide on managing VSCode extensions): Jupyter Extension, Python Extension

  4. Open or create a notebook file by opening the Command Palette (Ctrl+Shift+P) and select Jupyter: Create New Jupyter Notebook.

  1. Install Python using Miniconda via this download page

  2. Run the following three commands in a terminal or Anaconda prompt to update conda and create a conda environment

conda init
conda update -y conda
conda create -y --name ttk4130 python=3.11 sympy numpy scipy matplotlib ipython jupyter pythreejs -c conda-forge

  1. Install Visual Studio Code (VSCode) via the download page

  2. Start VSCode and activate your newly created Python environment, ttk4130 (See this guide on python environments)

  3. Install the following list of VSCode extensions (See this guide on managing VSCode extensions): Jupyter Extension, Python Extension

  4. Open or create a notebook file by opening the Command Palette (Command+Shift+P) and select Jupyter: Create New Jupyter Notebook.

  1. Install Python using Miniconda via this download page

  2. Run the following three commands in a terminal or Anaconda prompt to update conda and create a conda environment

conda init
conda update -y conda
conda create -y --name ttk4130 python=3.11 sympy numpy scipy matplotlib ipython jupyter pythreejs -c conda-forge

  1. Install Visual Studio Code (VSCode) via the download page

  2. Start VSCode and activate your newly created Python environment, ttk4130 (See this guide on python environments)

  3. Install the following list of VSCode extensions (See this guide on managing VSCode extensions): Jupyter Extension, Python Extension

  4. Open or create a notebook file by opening the Command Palette (Ctrl+Shift+P) and select Jupyter: Create New Jupyter Notebook.

Software Versions#

This website was built with the following software versions. If you are encountering compatability, issues this list can be used as a reference:

import platform
platform.python_version()

'3.11.14'

import IPython
IPython.__version__

'8.25.0'

import jupyter_sphinx
jupyter_sphinx.__version__

'0.5.3'

import matplotlib
matplotlib.__version__

'3.8.4'

import notebook
notebook.__version__

'7.2.3'

import numpy
numpy.__version__

'1.26.4'

import plotly
plotly.__version__

'6.5.2'

import pandas
pandas.__version__

'2.2.3'

import pythreejs._version
pythreejs._version.__version__

'2.4.2'

import sphinx_book_theme
sphinx_book_theme.__version__

'1.1.4'

import scipy
scipy.__version__

'1.14.1'

import sphinx
sphinx.__version__

'8.1.3'

import sphinx_material
sphinx_material.__version__

'0.0.36'

import sphinx_togglebutton
sphinx_togglebutton.__version__

'0.4.4'

import sphinx_design
sphinx_design.__version__

'0.7.0'

import sympy
sympy.__version__

'1.12.1'

import jupyterlite_sphinx
jupyterlite_sphinx.__version__

'0.16.5'

import jupyterlite_pyodide_kernel
jupyterlite_pyodide_kernel.__version__

'0.4.7'
Contents