Skoči na vsebino

Namestitev in prvi preizkus

Ustvarili bomo ločeno okolje Python 3, namestili Snakemake 9, pridobili oba repozitorija s primeri in izvedli preizkus z enim pravilom. Med delom v terminalu imejte to stran odprto.

Pred začetkom

Ukazi so namenjeni terminalu z lupino bash ali zsh na Linuxu ali macOS, kjer so Python 3, njegov modul venv in Git že nameščeni. Potrebujete tudi dostop do interneta in imenik, v katerega lahko zapisujete. Na Windows uporabite okolje Linux, na primer WSL; ukazov za izvorno lupino Windows tukaj ne obravnavamo. Druge načine namestitve opisujejo uradna navodila za Snakemake.

Pri pripravi delavnice smo uporabili Python 3.12 (preizkušena izdaja: 3.12.15). Spodnji ukazi zato uporabljajo python3.12.

Zaženite:

python3.12 --version
git --version

Prvi ukaz mora izpisati Python 3.12.x, drugi pa različico programa Git. Če katerega od ukazov ni, se pred nadaljevanjem o namestitvi dogovorite s predavateljem ali skrbnikom sistema. Na upravljani gruči sledite njenim navodilom za dostop do programske opreme, namesto da sami nameščate sistemsko programsko opremo.

Ta priprava zadošča za uvod in prvi primer delovnega toka. Znanstvena analiza bo dodatno potrebovala NumPy, SciPy, Matplotlib, h5py in iminuit; izvajanje na gruči pa svoje nastavitve. Te zahteve bomo uvedli pri ustreznih delih delavnice.

1. Ustvarite delovni imenik in okolje

V terminalu izberite nadrejeni imenik, v katerega lahko zapisujete. Naslednji ukazi ustvarijo nov imenik snakemake-workshop. Če imenik s tem imenom že obstaja, izberite drugo novo ime, da naloge ne pomešate s prejšnjim delom.

mkdir snakemake-workshop
cd snakemake-workshop
python3.12 -m venv .venv
source .venv/bin/activate

Imenik .venv vsebuje lokalno okolje Python. Z aktivacijo določite, da lupina uporablja njegov Python in nameščene ukaze. Paketi, nameščeni v njem, so ločeni od drugih okolij Python. Glejte dokumentacijo za navidezna okolja Python.

Naslednje korake izvajajte v istem terminalu. Vsi spodnji ukazi se začnejo v imeniku snakemake-workshop, razen kadar imenik spremenimo z ukazom cd.

2. Namestite in preverite Snakemake

Namestili bomo Snakemake 9.27.1, zadnjo stabilno izdajo ob pripravi delavnice (25. oktober 2026), navedeno na PyPI.

python -m pip install "snakemake==9.27.1"
python --version
snakemake --version
python -m pip check

Preverite, da Python izpiše 3.12.x, Snakemake 9.27.1, zadnji ukaz pa No broken requirements found. Različica Snakemake je določena, da vsi uporabljamo isto izdajo izvajalnega orodja. S tem še niso določene različice vseh posrednih odvisnosti.

Če lupina ukaza snakemake ne najde, preverite, da je bila aktivacija v prvem koraku uspešna in da se je namestitev končala brez napake. Po neuspešni namestitvi ne nadaljujte s primeri.

3. Pridobite gradiva

Še vedno v imeniku snakemake-workshop zaženite:

git clone https://github.com/leskovec/SnakeMake.intro.git
git clone https://github.com/leskovec/SnakeMake.main.git
git -C SnakeMake.intro checkout --detach 9080311347064dc48614633c3ddf7f48796d1503
git -C SnakeMake.main checkout --detach 97ae1cac38ea025585709ebe43f2ad9725f2f75f
ls SnakeMake.intro
ls SnakeMake.main

Prvi seznam mora vsebovati app.py, app_v0.py, script in snakemake, drugi pa data, program in program.solution. Izvirnih datotek za zdaj ne spreminjajte. Ukaza checkout izbereta posnetka, uporabljena pri pripravi teh poglavij. Git lahko izpiše opozorilo o stanju »detached HEAD«; to je pričakovano za izvorni kopiji, ki ju samo beremo. Reviziji zabeležite z:

git -C SnakeMake.intro rev-parse HEAD
git -C SnakeMake.main rev-parse HEAD

Izpisani zgoščeni vrednosti označujeta pridobljeni reviziji in pomagata pojasniti razlike, če se repozitorija pozneje spremenita.

4. Izvedite kratek preizkus namestitve

V ločenem imeniku bomo ustvarili majhno datoteko Snakefile. Vsebuje eno pravilo z imenom hello, katerega izhod je hello.txt. Ukaz lupine v to datoteko zapiše eno vrstico. Skladnjo pravil bomo obravnavali v naslednjem delu; tu želimo preveriti, ali namestitev lahko izvede posel.

V imeniku snakemake-workshop prekopirajte celoten spodnji blok. Končni EOF mora stati v svoji vrstici. S to skladnjo lupine vmesno besedilo zapišemo v datoteko Snakefile.

mkdir installation-check
cd installation-check
cat > Snakefile <<'EOF'
rule hello:
    output:
        "hello.txt"
    shell:
        "printf 'Snakemake is ready\\n' > {output}"
EOF

Za ta preizkus izrecno izberemo vgrajeni razporejevalnik greedy, ki ne potrebuje zunanjega optimizacijskega reševalnika. S tem določimo, kako Snakemake izbira pripravljene posle; ne gre za razporejevalnik na gruči.

Najprej preglejte načrt, ne da bi izvedli posel:

snakemake --cores 1 --scheduler greedy --dry-run

Načrt mora vsebovati en posel hello. Poskusni zagon tega majhnega delovnega toka ne ustvari datoteke hello.txt. Zdaj izvedite posel in preglejte izhod:

snakemake --cores 1 --scheduler greedy
cat hello.txt

Datoteka mora vsebovati natanko:

Snakemake is ready

Isti ukaz zaženite še enkrat:

snakemake --cores 1 --scheduler greedy

Če datoteke in delovnega toka niste spremenili, mora Snakemake sporočiti, da ni treba izvesti ničesar. Za ta preizkus smo zahtevali eno jedro; to ni meritev zmogljivosti.

5. Vrnite se v imenik delavnice

cd ..

Zdaj ste spet v imeniku snakemake-workshop, okolje pa je še vedno aktivno. Nastala je naslednja struktura:

snakemake-workshop/
├── .venv/
├── SnakeMake.intro/
├── SnakeMake.main/
└── installation-check/
    ├── Snakefile
    ├── hello.txt
    └── .snakemake/     (metapodatki izvajanja)

Ko pozneje odprete nov terminal, se vrnite v ta imenik in okolje ponovno aktivirajte z source .venv/bin/activate. Ob koncu dela z ukazom deactivate zapustite okolje, ne da bi izbrisali svoje delo.

Na prvi primer delovnega toka ste pripravljeni, ko preverjanje različic uspe, sta oba repozitorija prisotna, preizkus pa ustvari pričakovano vrstico in pri ponovnem zagonu brez sprememb ne izvaja dela. Nadaljujte z uvodnimi nalogami.

Dodatno: okolje za izvajalnik Slurm

Ta korak potrebujete le za način B v poglavju o gruči. Za zdaj ga lahko preskočite in se vrnete, ko pridete do tega poglavja. Ukaze izvedite v imeniku snakemake-workshop na gruči z njeno podprto namestitvijo Pythona. Vtičnik Slurm zahteva novejši NumPy, kot ga določa znanstveni primer, zato ga namestite v ločeno okolje:

python3.12 -m venv .venv-slurm
source .venv-slurm/bin/activate
python -m pip install "snakemake==9.27.1" "snakemake-executor-plugin-slurm==2.8.0"
python -m pip check
source .venv/bin/activate

Zadnji ukaz ponovno aktivira glavno okolje delavnice. Ko pridete do poglavja o gruči, aktivirajte .venv-slurm, kot je prikazano tam. Obe okolji morata biti na shrambi, dostopni računskim vozliščem.