__init__.py

#!/usr/bin/env python
"""
:copyright:
    Lion Krischer (lion.krischer@gmail.com), 2013-2021
:license:
    BSD 3-Clause ("BSD New" or "BSD Simplified")
"""
import sys


from .exceptions import ASDFException, ASDFWarning, WaveformNotInFileException
from .asdf_data_set import ASDFDataSet


__all__ = [
    "__version__",
    "ASDFDataSet",
    "ASDFException",
    "ASDFWarning",
    "WaveformNotInFileException",
    "print_sys_info",
    "get_sys_info",
]


if sys.version_info.minor >= 9:
    from importlib.metadata import version, PackageNotFoundError

    try:
        __version__ = version("pyasdf")
    except PackageNotFoundError:
        pass
else:
    import pkg_resources

    try:
        __version__ = pkg_resources.get_distribution("pyasdf").version
    except pkg_resources.DistributionNotFound:
        pass


def print_sys_info():
    """
    Prints information about the system, HDF5 and h5py version.

    Very useful to judge the installation.
    """
    from .watermark import get_watermark  # NOQA

    wm = get_watermark()

    info = (
        "pyasdf version {pyasdf_version}\n"
        "{div}\n"
        "{python} {py_version}, compiler: {py_compiler}\n"
        "{platform} {platform_release} {architecture}\n"
        "Machine: {machine}, Processor: {processor} with {count} cores\n"
        "{div}\n"
        "HDF5 version {hdf5_version}, h5py version: {h5py_version}\n"
        "MPI: {mpi_vendor}, version: {mpi_vendor_version}, "
        "mpi4py version: {mpi4py_version}\n"
        "Parallel I/O support: {is_parallel}\n"
        "Problematic multiprocessing: {problematic_mp}\n"
        "{div}\n"
        "Other_modules:\n\t{other_modules}"
    )

    print(
        info.format(
            pyasdf_version=__version__,
            div="=" * 79,
            python=wm["python_implementation"],
            py_version=wm["python_version"],
            py_compiler=wm["python_compiler"],
            platform=wm["platform_system"],
            platform_release=wm["platform_release"],
            architecture=wm["platform_architecture"],
            machine=wm["platform_machine"],
            processor=wm["platform_processor"],
            count=wm["platform_processor_count"],
            hdf5_version=wm["hdf5_version"],
            h5py_version=wm["module_versions"]["h5py"],
            mpi_vendor=wm["mpi_vendor"],
            mpi_vendor_version=wm["mpi_vendor_version"],
            mpi4py_version=wm["module_versions"]["mpi4py"],
            is_parallel=wm["parallel_h5py"],
            problematic_mp=wm["problematic_multiprocessing"],
            other_modules="\n\t".join(
                f"{key}: {value}"
                for key, value in sorted(
                    wm["module_versions"].items(), key=lambda x: x[0]
                )
                if key != "mpi4py" and key != "h5py"
            ),
        )
    )