TMA4320 Prosjekt 1

Denne teksten beskriver hvordan dere kan sette opp prosjektet, installere nødvendige pakker, og kjøre koden lokalt på deres maskin. Følg instruksjonene nøye for å sikre at alt fungerer som det skal.

OBS: En del har hatt problemer med å installere Jax på Mac med Intel-chip. Se i bunnen av denne filen for en fremgangsmåte!

Laste ned koden

Følg instruksjonene i Git-forelesningen for å kopiere koden som en template og laste den ned til deres maskin. For de som ikke ønsker å bruke Git, kan dere laste ned en zip-fil med koden direkte fra GitHub og pakke den ut på deres maskin.

Åpne prosjektet i en kode-editor

For å kjøre kommandoene nedenfor trenger dere også tilgang til en terminal. Det letteste er å åpne prosjektet i VSCode og bruke den innebygde terminalen (åpnes med Ctrl/Cmd+j). Eventuelt bruk terminalen på deres maskin direkte, men husk å navigere til mappen med koden først.

Installere Python

Verifiser at dere har installert Python 3.13 eller nyere på deres maskin. Dette kan dere gjøre ved å åpne terminalen og skrive python --version eller python3 --version.

python --version
# eller evt. (avhengig av systemet deres)
python3 --version

Dersom dere får opp en versjon som er 3.13 eller nyere, er alt i orden. Hvis ikke, må dere installere Python. Følg instruksjonene på Python Downloads for å installere nyeste versjon av Python på deres maskin.

Merk: Dersom dere måtte skrive python3 for å få opp riktig versjon, må dere bruke python3 i stedet for python i alle kommandoer nedenfor`

Installere pakker i et virtuelt miljø

For å kjøre koden trenger dere å installere noen Python-pakker og sette opp et virtuelt miljø. Fra tidligere er dere nok mest vant med å bruke pip og venv for å håndtere dette. Et mer moderne alternativ er å bruke uv. Personlig synes jeg dette er et enklere og bedre verktøy for dette formålet. Jeg vil beskrive begge fremgangsmåtene, og dere kan selv velge hvilket dere ønsker å bruke.

pip og venv

Lag et virtuelt miljø

python -m venv .venv

Aktiver det virtuelle miljøet

# Mac/Linux
source .venv/bin/activate
# Windows (PowerShell)
.venv\Scripts\Activate.ps1

Windows-brukere: Dersom du får en feilmelding om at skript ikke er tillatt, kjør først denne kommandoen i PowerShell:

Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser

Deretter kan du prøve å aktivere det virtuelle miljøet på nytt.

Oppdater pip inne i det virtuelle miljøet

pip install --upgrade pip setuptools wheel

Installer pakkene i pyproject.toml med kommandoen

pip install -e . --group dev

Dersom du ikke får noen feil har alt gått fint!

uv

Følg instruksjonene på Installing uv for å sette opp på deres maskin. Verifiser at uv er installert ved å kjøre

uv --version

Dersom dere ønsker kan dere også enkelt installere nyeste version av Python gjennom uv ved å kjøre (merk at dette er valgfritt)

uv python install

Til slutt genererer du et virtuelt miljø og installerer pakker spesifisert i pyproject.toml ved å bruke kommandoen

uv sync

Du kan eventuelt sette opp en kernel for Jupyter notebooks gjennom

uv run ipython kernel install --user --env VIRTUAL_ENV $(pwd)/.venv --name=project

Dersom du ikke får noen feil har alt gått fint!

Velge Interpreter i VSCode (dersom du bruker dette...)

Etter du har satt opp prosjektet kan det hende du må velge riktig Python Iinterpreter i VSCode. Åpne kommandopalletten med Ctrl/Cmd+Shift+P, og søk etter Python: Select Interpreter. Velg deretter den som peker til .venv-mappen i prosjektet ditt.

Kjøre kode

Pass på at ditt virtuelle miljø er aktivert

# Mac/Linux
source .venv/bin/activate
# Windows (PowerShell)
.venv\Scripts\Activate.ps1

Windows-brukere: Se merknaden under "pip og venv"-seksjonen dersom du får en feilmelding om at skript ikke er tillatt.

Vi kjører kode fra terminalen gjennom å skrive python <filsti>. Test at alt fungerer ved å kjøre scripts/run_fdm.py med kommandoen

python scripts/run_fdm.py

Dersom du ikke får noen feil så er alle pakker installert riktig, og du er klar til å begynne på prosjektet! Merk at output fra kjøringen vil selvfølgelig være gal siden vi ikke har implementert noe enda.

For å kjøre tester på koden kan du bruke pytest. Kjør alle tester med kommandoen

pytest

eller kjør en spesifikk testfil med kommandoen

pytest tests/<sti-til-test>.py
# eller
pytest tests/<sti-til-test>.py::<test-klassenavn>

Fiks for å installere på Mac med Intel-chip

For å installere på Mac med Intel-chip, er vi nødt til å bruke Anaconda for å håndtere avhengigheter.

Pass på å slette eventuelle virtuelle miljøer du har laget tidligere for dette prosjektet før du begynner. Bruk

deactivate
# Mac/Linux
rm -rf .venv
# Windows (PowerShell)
Remove-Item -Recurse -Force .venv

Sjekk om du har Anaconda installert ved å kjøre

conda --version

Dersom du ikke har det, installer Anaconda herfra: https://www.anaconda.com/download. Etter du har installert Anaconda kan det hende du initialiserer conda med kommandoen

# Dersom du bruker bash
conda init bash
# Dersom du bruker zsh
conda init zsh
# Dersom du bruker powershell
conda init powershell

Deretter må du lukke og åpne terminalen på nytt for at endringene skal tre i kraft.

Erstatt pyproject.toml med innholdet

[project]
name = "project"
version = "0.1.0"
description = "PINN for room heating simulation"
readme = "README.md"
authors = [
    { name = "Elling Svee", email = "86355496+ellingsvee@users.noreply.github.com" }
]
requires-python = ">=3.12"
dependencies = []

[dependency-groups]
dev = []

Lag et conda-miljø for Python 3.12:

conda create -n project python=3.12
conda activate project

Dersom du bruker VSCode, åpne kommandopalletten med Ctrl/Cmd+Shift+P, og søk etter Python: Select Interpreter. Velg deretter den som peker til conda-miljøet du nettopp laget. På denne måten slipper du å aktivere miljøet manuelt hver gang du åpner prosjektet i VSCode.

Kjør deretter kommandoen for å aktivere prosjektet:

pip install -e .

Installer så Jax

conda install -c conda-forge jax jaxlib

og deretter resten av avhengighetene:

conda install numpy scipy matplotlib tqdm pytest pyyaml ipykernel 

Test at alt fungerer ved å kjøre scripts/run_fdm.py med kommandoen

python scripts/run_fdm.py