NGSPICE(1)

πŸ“¦
version 47 Β· 2 versions
, in alpine 3.24, arch rolling, fedora 43, fedora 44, nixos 26.05, nixpkgs unstable, ubuntu resolute, ubuntu stonking

✨ NGSPICE ✨

okay bestie, gather round, because this is the ngspice man page πŸ’… β€” a circuit simulator derived from SPICE3f5, and yes she is that girl. πŸŽ€


🌸 NAME 🌸

ngspice β€” a circuit simulator derived from SPICE3f5. no cap, that's literally what she is. πŸ¦‹


🫢 SYNOPSIS 🫢

ngspice [options] [file ...]

πŸ’– DESCRIPTION πŸ’–

okay so real talk: this man page is just a lil overview, she's the appetizer not the meal πŸ“. The primary documentation of ngspice lives in the ngspice User's Manual, which you can get as a pdf or an html file. so if you need the deep lore, that's where it's at. ✨


πŸ‘‘ OPTIONS πŸ‘‘

  • -n, --no-spiceinit β€” don't even try to source the file .spiceinit at startup. Normally ngspice goes looking for that file in the current directory first, and if she can't find it there, she checks the user's home directory. this flag says "girl, don't bother". πŸ’…
  • -t term, --term=term β€” the program is being run on a terminal whose mfb name is term. 🌈
  • -b, --batch β€” run in batch mode. ngspice will read the standard input or the specified input file and do the simulation. ⚠️ heads up bestie: if the standard input is not a terminal, ngspice will default to batch mode, unless you gave the -i flag. iykyk.
  • -s, --server β€” run in server mode. this is like batch mode, except a temporary rawfile is used and then written to the standard output, preceded by a line with a single "@", after the simulation is done. this mode is used by the ngspice daemon. serving, literally. πŸ”₯
  • -i, --interactive β€” run in interactive mode. super useful if the standard input is not a terminal but you still want interactive mode. however πŸ‘€: command completion is not available unless the standard input is a terminal. tragic, i know. 😭
  • -r rawfile, --rawfile=file β€” use rawfile as the default file into which the results of the simulation get saved. πŸŽ€
  • -c circuitfile, --circuitfile=circuitfile β€” use circuitfile as the default input deck. πŸ““
  • -h, --help β€” display a verbose help on the arguments available to the program. bestie behavior, honestly. 🫢
  • -v, --version β€” display a version number and copyright information of the program. πŸ’œ
  • -a, --autorun β€” FIXME. that's it. that's the whole description. not me leaving it exactly as she is πŸ™ˆ.
  • -o outfile, --output=outfile β€” all logs generated during a batch run (-b) will be saved in outfile. 🌸
  • -p, --pipe β€” allow a program (e.g., xcircuit) to act as a GUI frontend for ngspice through a pipe. so ngspice will assume that the pipe is a tty and allows one to run in interactive mode. iconic pipeline energy. πŸ¦‹

any further arguments are taken to be SPICE input decks, which are read and saved. and if batch mode is requested, then they are run immediately. ⭐


🌈 ENVIRONMENT 🌈

  • SPICE_LIB_DIR
  • SPICE_EXEC_DIR
  • SPICE_HOST
  • SPICE_BUGADDR
  • SPICE_EDITOR
  • SPICE_ASCIIRAWFILE β€” default 0. the format of the rawfile. 0 for binary, and 1 for ascii. pick your fighter πŸ’€
  • SPICE_NEWS β€” default $SPICE_LIB_DIR/news. a file which is copied verbatim to stdout when ngspice starts in interactive mode. it's giving morning newsletter β˜•βœ¨
  • SPICE_MFBCAP β€” default $SPICE_LIB_DIR/mfbcap
  • SPICE_HELP_DIR β€” default $SPICE_LIB_DIR/helpdir
  • SPICE_SCRIPTS β€” default $SPICE_LIB_DIR/scripts. in this directory the spinit file will be searched. πŸ”
  • SPICE_PATH β€” default $SPICE_EXEC_DIR/ngspice

πŸ’« various undocumented ngspice centric environment variables πŸ’«

  • NGSPICE_MEAS_PRECISION
  • SPICE_NO_DATASEG_CHECK

(undocumented. mysterious. main character energy. we simply do not know. 🧚)


πŸ’œ Common environment variables πŸ’œ

  • TERM LINES COLS DISPLAY HOME PATH EDITOR SHELL
  • POSIXLY_CORRECT

πŸŽ€ FILES πŸŽ€

  • $SPICE_LIB_DIR/scripts/spinit β€” the System's Initialisation File. πŸ‘‘
  • .spiceinit or $HOME/.spiceinit β€” the User's Initialisation File. 🫢

⭐ SEE ALSO ⭐

sconvert(1), ngnutmeg(1), mfb(3), writedata(3), and the ngspice User's Manual at http://ngspice.sourceforge.net/docs.html


πŸ› BUGS πŸ›

please report bugs to the ngspice project via http://ngspice.sourceforge.net/bugrep.html β€” she wants to hear from you fr fr πŸ’–


πŸ‘‘ AUTHORS πŸ‘‘


and that's the whole page bestie!! πŸ¦‹ this overview comes from the General Commands Manual, dated 2014-10-28, and it's page NGSPICE(1) of the manual set. slay, go simulate something. πŸ’…βœ¨πŸŒˆ

πŸ“¦ where this page comes from