MULTIBINIT(1)

πŸ“¦
version 9.10.4 Β· 3 versions
, in ubuntu questing

πŸ’– MULTIBINIT β€” bestie edition πŸ’–

okay so. multibinit is the Ab initio atomic-scale simulation software and yes she's iconic for it. This page is the manual for her, MULTIBINIT(1), User Commands energy, and I'm gonna walk you through every single flag because you deserve to know them all. no gatekeeping in this house 🫢


✨ DESCRIPTION ✨

like, all the options. every last one. grab a snack πŸ“

  • -v, --version β€” shows the version number and then dips. bye πŸ’…
  • -b, --build β€” shows the build parameters and exits. receipts, basically 🧾
  • -d, --dry-run β€” checks your input file is valid and then exits. a little vibe check before the real thing ✨
  • -j, --omp-num-threads β€” sets the number of OpenMp threads.
  • --use-xgemm3m[=yesno] β€” use ZGEMM3M routines instead of ZGEMM. Default: no
  • --use-mpi-in-place[=yesno] β€” turns usage of MPI_IN_PLACE on/off, in e.g. xmpi_sum. Default: no
⚠️ heads up bestie: some MPI libs, e.g. intel-mpi, may not implement this feature correctly, so it is adviced to test this option with e.g. structural relaxations before running production calculations. lowkey important, don't skip the testing era 😭
  • --ipi β€” activates socket-driven calculation using the i-pi protocol. For UNIX socket, use: --ipi {unixsocket}:UNIX. For INET socket, use --ipi {host}:{port}.

Usage example:

abinit run.abi --ipi {unixsocket}:UNIX > run.log

NB: Requires ionmov 28 and some tuning of input variables. See: https://wiki.fysik.dtu.dk/ase/dev/ase/calculators/socketio/socketio.html

  • --log β€” enables log files and status files in parallel execution. paper trail, we love her πŸ“
  • --netcdf-classic β€” use netcdf classic mode for new files if parallel-IO is not needed. Default is netcdf4/hdf5.
  • --enforce-fortran-io β€” use Fortran-IO instead of MPI-IO when operating on Fortran files. Useful to read files when the MPI-IO library is not efficient.
🚨 DON'T USE this option when the code needs to write large files e.g. WFK. I'm so serious. not the move.
  • -t, --timelimit β€” sets the timelimit for the run. Accepts time in Slurm syntax:
days-hours
days-hours:minutes
days-hours:minutes:seconds
minutes
minutes:seconds
hours:minutes:seconds

At present only GS, relaxations and MD runs support this option. the rest said not today πŸ™ˆ

  • --mem-per-cpu=<size>[units] β€” set memory per cpu using Slurm syntax. Default units are megabytes. Different units can be specified using the suffix [K|M|G|T].
  • --mem=<size>[units] β€” set memory per node using Slurm syntax. Default units are megabytes. Requires ntasks-per-node. Not compatibile with -mem-per-cpu. pick a lane bestie, you can't have both πŸ’€
  • --ntasks-per-node=INT β€” set number of tasks per node. Used in conjunction with `--mem``
  • --verbose β€” enable verbose mode in argparse. she talks a lot and that's her right πŸ‘‘
  • -h, --help β€” shows this help and exits. you are here πŸŽ€

πŸ› οΈ Options for developers πŸ› οΈ

this is the VIP section, iykyk. the original header was literally:

============================== === Options for developers ===
============================== --abimem-level NUM         Set
memory profiling level. Requires HAVE_MEM_PROFILING
--abimem-limit-mb NUM      Log malloc/free only if size > limit
in Megabytes. Requires abimem-level 3 --fft-ialltoall[=yesno]
Use non-blocking ialltoall in MPI-FFT (used only if ndat > 1 and
MPI2+).  --gnu-mtrace               Enable mtrace (requires GNU
and clib).  --ieee-halt                Halt the code if one of
the *usual* IEEE exceptions is raised.  --ieee-signal
Signal the occurrence of the *usual* IEEE exceptions.  --F03
Run F03 mode (for Multibinit only).

and here they all are, un-smooshed for your reading pleasure πŸ¦‹

  • --abimem-level NUM β€” set memory profiling level. Requires HAVE_MEM_PROFILING.
  • --abimem-limit-mb NUM β€” log malloc/free only if size > limit in Megabytes. Requires abimem-level 3.
  • --fft-ialltoall[=yesno] β€” use non-blocking ialltoall in MPI-FFT (used only if ndat > 1 and MPI2+).
  • --gnu-mtrace β€” enable mtrace (requires GNU and clib).
  • --ieee-halt β€” halt the code if one of the usual IEEE exceptions is raised.
  • --ieee-signal β€” signal the occurrence of the usual IEEE exceptions.
  • --F03 β€” run F03 mode (for Multibinit only).

🌈 SEE ALSO 🌈

The full documentation for multibinit is maintained as a Texinfo manual. If the info and multibinit programs are properly installed at your site, the command

info multibinit

should give you access to the complete manual. go read her, she ate πŸ“šβœ¨


and that's the whole page bestie!! this was multibinit version 9.10.4, dated December 2024, living her life under MULTIBINIT(1). slay, periodt, go run some simulations πŸ’–πŸ’…πŸ¦‹

πŸ“¦ where this page comes from