<commit_before>#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""Routines for working with BMRB NMR-STAR format files.

This package includes the following modules:

``nmrstarlib``
    This module provides the :class:`~nmrstarlib.nmrstarlib.StarFile` class which is a python
    dictionary representation of a BMRB NMR-STAR file. Data can be accessed
    directly from the :class:`~nmrstarlib.nmrstarlib.StarFile` instance using bracket accessors.
    The :mod:`~nmrstarlib.nmrstarlib` module relies on the :mod:`~nmrstarlib.bmrblex` module
    for processing of tokens.

``bmrblex``
    This module provides the :func:`~nmrstarlib.bmrblex.bmrblex` generator that is responsible
    for the syntax analysis of BMRB NMR-STAR files, processing word, number, single quoted,
    double quoted, multiline quoted BMRB tokens.

``converter``
    This module provides the :class:`~nmrstarlib.converter.Converter` class that is
    responsible for the conversion of NMR-STAR formated files.

``csviewer``
    This module provides the :class:`~nmrstarlib.csviewer.CSViewer` class that visualizes
    chemical shift values using the Graphviz (http://www.graphviz.org/) DOT Languge description
    and provides code example for utilizing the library.

``noise``
    This module provides the :class:`~nmrstarlib.noise.NoiseGenerator` abstract class and derived
    :class:`~nmrstarlib.noise.RandomNormalNoiseGenerator` for adding random normal noise values
    to peaks in simulated peak list.

``plsimulator``
    This module provides necessary interfaces in order to create a simulated
    :class:`~nmrstarlib.plsimulator.PeakList`.

``translator``<commit_msg>Updated package level init doc.<commit_after>#!/usr/bin/env python3
# -*- coding: utf-8 -*-

"""Routines for working with BMRB NMR-STAR format files.

This package includes the following modules:

``nmrstarlib``
    This module provides the :class:`~nmrstarlib.nmrstarlib.StarFile` class which is a python
    dictionary representation of a BMRB NMR-STAR file. Data can be accessed
    directly from the :class:`~nmrstarlib.nmrstarlib.StarFile` instance using bracket accessors.
    The :mod:`~nmrstarlib.nmrstarlib` module relies on the :mod:`~nmrstarlib.bmrblex` module
    for processing of tokens.

``bmrblex``
    This module provides the :func:`~nmrstarlib.bmrblex.bmrblex` generator that is responsible
    for the syntax analysis of BMRB NMR-STAR files, processing word, number, single quoted,
    double quoted, multiline quoted BMRB tokens.

``converter``
    This module provides the :class:`~nmrstarlib.converter.Converter` class that is
    responsible for the conversion of NMR-STAR formated files.

``csviewer``
    This module provides the :class:`~nmrstarlib.csviewer.CSViewer` class that visualizes
    chemical shift values using the Graphviz (http://www.graphviz.org/) DOT Languge description
    and provides code example for utilizing the library.

``noise``
    This module provides the :class:`~nmrstarlib.noise.NoiseGenerator` class 
    for adding random normal noise values to peaks in simulated peak list.

``plsimulator``
    This module provides necessary interfaces in order to create a simulated
    :class:`~nmrstarlib.plsimulator.PeakList`.

``translator``
{'fraction_non_alphanumeric': 0.08641975308641975, 'fraction_numerical': 0.0012345679012345679, 'mean_word_length': 4.483925549915398, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1269457', 'n_tokens_mistral': 996, 'n_tokens_neox': 930, 'n_words': 339}