Skip to main content
Ctrl+K
Wulfric - Home Wulfric - Home
  • User Guide
  • User support
  • API reference
  • Release notes
    • Contributor`s guide
    • Whom to cite?
    • Example of wulfric's capabilities
  • GitHub
  • PyPI
  • User Guide
  • User support
  • API reference
  • Release notes
  • Contributor`s guide
  • Whom to cite?
  • Example of wulfric's capabilities
  • GitHub
  • PyPI

Section Navigation

Submodules

  • wulfric.cell
  • wulfric.crystal
  • wulfric.kpoints
  • wulfric.constants
  • wulfric.io
  • wulfric.geometry

Classes

  • wulfric.Kpoints
  • wulfric.PlotlyEngine
  • wulfric.SyntacticSugar

Top level functions

  • wulfric.compare_with_tolerance
  • wulfric.add_sugar
  • wulfric.remove_sugar
  • wulfric.logo

Spglib interface

  • wulfric.SpglibData
  • wulfric.get_spglib_data
  • wulfric.get_spglib_types
  • wulfric.validate_spglib_data

Unit tests

  • wulfric.test

Exceptions

  • wulfric.ConventionNotSupported
  • wulfric.FailedToDeduceAtomSpecies
  • wulfric.NiggliReductionFailed
  • wulfric.PotentialBugError

Legacy code

  • wulfric.lepage
  • API reference
  • wulfric.logo

wulfric.logo#

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

Generates logo of wulfric with some information about the package

Parameters:
infolist of str, optional

Information about the package, that is displayed below the logo. Each element should not exceed 50 characters. by default it displays the version, release date, git hash and documentation link. You can pass th empty list to display only the logo.

line_lengthint, optional

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

flatbool

Whether to return a flat logo or not.

date_timebool, default False

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

commentstr or bool, optional

Whether to use some character at the end 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.

Examples

>>> import wulfric
>>> print(wulfric.logo(info=[]))
██╗      ██╗ ██╗   ██╗ ██╗      ███████╗ ██████╗  ██╗  ██████╗
██║      ██║ ██║   ██║ ██║      ██╔════╝ ██╔══██╗ ██║ ██╔════╝
██║  █╗  ██║ ██║   ██║ ██║      █████╗   ██████╔╝ ██║ ██║
██║ ███╗ ██║ ██║   ██║ ██║      ██╔══╝   ██╔══██╗ ██║ ██║
╚███╔══███╔╝ ╚██████╔╝ ███████╗ ██║      ██║  ██║ ██║ ╚██████╗
╚══╝  ╚══╝   ╚═════╝  ╚══════╝ ╚═╝      ╚═╝  ╚═╝ ╚═╝  ╚═════╝

previous

wulfric.remove_sugar

next

wulfric.SpglibData

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

© Copyright 2023, Andrey Rybakov.

Created using Sphinx 9.0.4.

Built with the PyData Sphinx Theme 0.18.0.