Bevezetés

Üdvözöllek a Dokumentációs oldalon!

Ezen az oldalon összegyűjve megtalálod a dokumentációban használt különböző jelölésket.

Kódpéldák

A forráskódot mindig code-block direktívával adjuk meg. A direktíva után ures sor következik, majd a kód következetesen behúzva jelenik meg.

Python példa:

from molecule import Simulation

sim = Simulation("water.xyz")
sim.run(steps=1000)

Inline kódrészletekhez dupla backtick-et használunk, például: Simulation.run().

Parancssori (bash) utasítások

A terminálparancsokat bash típusú kódblokkban dokumentáljuk:

molsim prepare input.yaml
molsim run --nsteps 5000

Megjegyzés: a $ prompt elhagyásra kerül, hogy a parancsok könnyen másolhatók legyenek.

Bemeneti fájlok (input)

A bemeneti fájlok teljes tartalmát vagy releváns részleteit önálló blokkban mutatjuk be.

Példa YAML input fájl:

system:
  molecule: water
  charge: 0

simulation:
  method: DFT
  steps: 1000

Hosszabb fájlok esetén csak a lényeges részeket emeljük ki.

Kimeneti fájlok (output)

A kimeneti fájlok lehetnek logok, táblázatok vagy strukturált adatok.

Példa szöveges kimenet:

Step   Energy (Hartree)
1      -76.345
2      -76.351
...

Az egységeket és oszlopneveket mindig feltüntetjük.

Megjegyzések és figyelmeztetések

Fontos információkat Sphinx direktívákkal emelünk ki:

Note

A bemeneti fájlok formátuma verziónként változhat.

Warning

Nagy rendszerek esetén a számítás jelentős memória- és időigénnyel járhat.

Konvenciók összefoglalása

• Kód: .. code-block:: <nyelv> + következetes behúzás

• Parancsok: bash blokk, prompt nélkül

• Input/Output: teljes, másolható példák

• Inline kód: dupla backtick használata

Ez a formátum a dokumentáció minden további oldalán következetesen alkalmazásra kerül.