<commit_before>PolyADCIRC
==========

This code has been documented with Sphinx. To build documentation run 
``make html`` in the ``doc/`` folder.
All documentation is contained in ``doc/_build/_html`` 
To build/update the documentation use the following commands::

    sphinx-apidoc -f -o doc polyadcirc
    cd doc
    make html
    make html

You will need to run sphinx-apidoc anytime a new module or method in the source code has been added. If only the *.rst files have changed then you can simply run ``make html`` twice in the doc folder.

Useful scripts are contained in ``examples/``
Python source code for this package is contained in ``polyadcirc/``<commit_msg>added note about NSF funding<commit_after>PolyADCIRC
==========

This code has been documented with Sphinx. To build documentation run 
``make html`` in the ``doc/`` folder.
All documentation is contained in ``doc/_build/_html`` 
To build/update the documentation use the following commands::

    sphinx-apidoc -f -o doc polyadcirc
    cd doc
    make html
    make html

You will need to run sphinx-apidoc anytime a new module or method in the source code has been added. If only the *.rst files have changed then you can simply run ``make html`` twice in the doc folder.

Useful scripts are contained in ``examples/``
Python source code for this package is contained in ``polyadcirc/``

This material is based upon work supported by the National Science Foundation
Graduate Research Fellowship under Grant No. DGE-1110007. Any opinion,
findings, and conclusions or recommendations expressed in this material are
those of the authors(s) and do not necessarily reflect the views of the
National Science Foundation.

{'fraction_non_alphanumeric': 0.06986382474837181, 'fraction_numerical': 0.0041444641799881585, 'mean_word_length': 4.184049079754601, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, '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': '1479090', 'n_tokens_mistral': 449, 'n_tokens_neox': 423, 'n_words': 244}