Skip to main content
Ctrl+K

magnopy

  • User Guide
  • User support
  • API reference
  • Release notes
    • How to cite?
    • Developer's guide
  • GitHub
  • PyPI
  • User Guide
  • User support
  • API reference
  • Release notes
  • How to cite?
  • Developer's guide
  • GitHub
  • PyPI

Section Navigation

  • magnopy.io
  • magnopy.scenarios
  • magnopy.examples
  • magnopy.si
  • magnopy.experimental
  • magnopy.Convention
  • magnopy.SpinHamiltonian
  • magnopy.Energy
  • magnopy.LSWT
  • magnopy.PlotlyEngine
  • magnopy.solve_via_colpa
  • magnopy.span_local_rf
  • magnopy.span_local_rfs
  • magnopy.logo
  • magnopy.multiprocess_over_k
  • magnopy.make_supercell
  • magnopy.converter22
  • magnopy.converter422
  • magnopy.ConventionError
  • magnopy.ColpaFailed
  • API reference
  • magnopy.logo

magnopy.logo#

magnopy.logo(info=None, line_length=None, flat=False, date_time=False, comment=None)[source]#

Logo generator for Magnopy package.

Returns the logo and information about the package.

Parameters:
infolist of str, optional

Information about the package, that is displayed below the logo. Each element should not exceed 58 characters. By default it displays the version, link to the documentation, release date and license. Pass an empty list to display the logo only.

line_lengthint, optional

Length of the lines to be returned. Minimum value is 70.

flatbool

Whether to return a flat logo or not.

date_timebool, default False

Whether to include the date and time to the info or not.

commentstr or bool, optional

Whether to use some character at the beginning of each string. If bool and True, then "# " is used. If str, then this string is used. If None, then no character is used.

Returns:
logo_infostr

Logo and information about the package.

previous

magnopy.span_local_rfs

next

magnopy.multiprocess_over_k

On this page
  • logo()
Edit on GitHub

This Page

  • Show Source

© Copyright 2023-2025, Magnopy Team.

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.16.1.