pint.utils.info_string

pint.utils.info_string(prefix_string='# ', comment=None, detailed=False)[source]

Returns an informative string about the current state of PINT.

Adds:

Creation date
PINT version
Username (given by the gitpython global configuration user.name if available, in addition to getpass.getuser()).
Host (given by platform.node())
OS (given by platform.platform())
plus a user-supplied comment (if present).

Parameters:

prefix_string (str, default='# ') – a string to be prefixed to the output (often to designate as a comment or similar)
comment (str, optional) – a free-form comment string to be included if present
detailed (bool, optional) – Include detailed version info on dependencies.

Returns:

informative string

Return type:

str

Examples

>>> import pint.utils
>>> print(pint.utils.info_string(prefix_string="# ",comment="Example comment"))
# Created: 2021-07-21T09:39:45.606894
# PINT_version: 0.8.2+311.ge351099d
# User: David Kaplan (dlk)
# Host: margle-2.local
# OS: macOS-10.14.6-x86_64-i386-64bit
# Comment: Example comment

Multi-line comments are allowed:

>>> import pint.utils
>>> print(pint.utils.info_string(prefix_string="C ",
...                              comment="Example multi-line comment\nAlso using a different comment character"))
C Created: 2021-07-21T09:40:34.172333
C PINT_version: 0.8.2+311.ge351099d
C User: David Kaplan (dlk)
C Host: margle-2.local
C OS: macOS-10.14.6-x86_64-i386-64bit
C Comment: Example multi-line comment
C Comment: Also using a different comment character

Full example of writing a par and tim file:

>>> from pint.models import get_model_and_toas
>>> # the locations of these may vary
>>> timfile = "tests/datafile/NGC6440E.tim"
>>> parfile = "tests/datafile/NGC6440E.par"
>>> m, t = get_model_and_toas(parfile, timfile)
>>> print(m.as_parfile(comment="Here is a comment on the par file"))
# Created: 2021-07-22T08:24:27.101479
# PINT_version: 0.8.2+439.ge81c9b11.dirty
# User: David Kaplan (dlk)
# Host: margle-2.local
# OS: macOS-10.14.6-x86_64-i386-64bit
# Comment: Here is a comment on the par file
PSR                            1748-2021E
EPHEM                               DE421
CLK                             UTC(NIST)
...

>>> from pint.models import get_model_and_toas
>>> import io
>>> # the locations of these may vary
>>> timfile = "tests/datafile/NGC6440E.tim"
>>> parfile = "tests/datafile/NGC6440E.par"
>>> m, t = get_model_and_toas(parfile, timfile)
>>> f = io.StringIO(parfile)
>>> t.write_TOA_file(f, comment="Here is a comment on the tim file")
>>> f.seek(0)
>>> print(f.getvalue())
FORMAT 1
C Created: 2021-07-22T08:24:27.213529
C PINT_version: 0.8.2+439.ge81c9b11.dirty
C User: David Kaplan (dlk)
C Host: margle-2.local
C OS: macOS-10.14.6-x86_64-i386-64bit
C Comment: Here is a comment on the tim file
unk 1949.609000 53478.2858714192189005 21.710 gbt  -format Princeton -ddm 0.0
unk 1949.609000 53483.2767051885165973 21.950 gbt  -format Princeton -ddm 0.0
unk 1949.609000 53489.4683897879295023 29.950 gbt  -format Princeton -ddm 0.0
....

Notes

This can be called via write_TOA_file() on a TOAs object, or as_parfile() on a TimingModel object.