Skip to main content
Ctrl+K
magnopy - Home magnopy - Home
  • 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.is_eigenstate
  • magnopy.converter22
  • magnopy.converter43
  • magnopy.get_equivalent_parameters
  • magnopy.test
  • magnopy.ConventionError
  • magnopy.ColpaFailed
  • API reference
  • magnopy.logo

magnopy.logo#

magnopy.logo(date_time=False, comment_char=None, logo_width=None, **kwargs)[source]#

Generates a logo of Magnopy.

Returns the logo and some information about the package.

Parameters:
date_timebool, default False

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

comment_charstr or bool, optional

Changed in version 0.6.0:: Renamed from comment

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.

logo_widthint, optional

Including comment_char. The logo will be centered in the string of this width. By default it is the maximum between the width of the logo and the width of lines in the info.

**kwargs

For backwards compatibility.

Returns:
logo_stringstr

Logo and information about the package. Use print(logo()) to display it.

previous

magnopy.span_local_rfs

next

magnopy.multiprocess_over_k

On this page
  • logo()
Edit on GitHub
Show Source

© Copyright 2023, Magnopy Team.

Created using Sphinx 9.1.0.

Built with the PyData Sphinx Theme 0.19.0.