semvec/pypi-packages huggingface dataset:
pydwrf 0.15
DART/WRF utilities in python
License: BSD

This file requires editing
==========================

Note to the author: Please add something informative to this README *before*
releasing your software, as `a little documentation goes a long way`_.  Both
README.rst (this file) and NEWS.txt (release notes) will be included in your
package metadata which gets displayed in the PyPI page for your project.

You can take a look at the README.txt of other projects, such as repoze.bfg
(http://bfg.repoze.org/trac/browser/trunk/README.txt) for some ideas.

.. _`a little documentation goes a long way`: http://www.martinaspeli.net/articles/a-little-documentation-goes-a-long-way

Credits
-------

- `Distribute`_
- `Buildout`_
- `modern-package-template`_

.. _Buildout: http://www.buildout.org/
.. _Distribute: http://pypi.python.org/pypi/distribute
.. _`modern-package-template`: http://pypi.python.org/pypi/modern-package-template


.. This is your project NEWS file which will contain the release notes.
.. Example: http://www.python.org/download/releases/2.6/NEWS.txt
.. The content of this file, along with README.rst, will appear in your
.. project's PyPI page.

News
====

0.2a1
-----

*Release date: UNRELEASED*

* Example news entry for the in-development version


0.1
---

*Release date: 15-Mar-2010*

* Example news entry for a released version
FinnSyll 2.0.0
Finnish syllabifier and compound segmenter
License: BSD
Keywords: Finnish syllabifier compound segmenter

.. image:: https://travis-ci.org/tsnaomi/finnsyll.svg?branch=master
    :target: https://travis-ci.org/tsnaomi/finnsyll

FinnSyll
********

FinnSyll is a Python library that syllabifies words according to Finnish syllabification principles.
It is also equipped with a Finnish compound splitter. 
More details/docs to come.

Installation
============
::

        $ pip install FinnSyll

Basic usage
===========

First, instantiate a ``FinnSyll`` object. ::

        >>> from finnsyll import FinnSyll
        >>> f = FinnSyll()

To syllabify: ::

        >>> f.syllabify('runoja')
        ['ru.no.ja']  # internal syllable boundaries are indicated with '.'

To segment compounds: ::

        >>> f.split('sosiaalidemokraattien')
        'sosiaali=demokraattien'  # internal word boundaries are indicated with '='

Optional arguments
==================

The syllabifier can be customized along two different parameters: variation and compound splitting.  

variation
---------

Instantiating a ``FinnSyll`` object with ``variation=True`` (default) will allow the syllabifier to return multiple syllabifications if variation is predicted. When ``variation=True``, the syllabifier will return a list. Setting ``variation`` to ``False`` will cause the syllabifier to return a string containing the first predicted syllabification. 

*Variation*: ::

        >>> f = FinnSyll(variation=True) 
        >>> f.syllabify('runoja')
        ['ru.no.ja']
        >>> f.syllabify('vapaus')
        ['va.pa.us', 'va.paus']

*No variation*: ::

        >>> f = FinnSyll(variation=False)
        >>> f.syllabify('runoja')
        'ru.no.ja'
        >>> f.syllabify('vapaus')
        'va.pa.us'

split_compounds
---------------

When instantiating a ``FinnSyll`` object with ``split_compounds=True`` (default), the syllabifier will first attempt to split the input into constituent words before syllabifying it. This forces the syllabifier to insert a syllable boundary in between identified constituent words. The syllabifier will skip this step if ``split_compounds`` is set to ``False``.

*Compound splitting*: ::

        >>> f = FinnSyll(split_compounds=True) 
        >>> f.syllabify('rahoituserien')  # rahoitus=erien
        ['ra.hoi.tus.e.ri.en']

*No compound splitting*: ::

        >>> f = FinnSyll(split_compounds=False) 
        >>> f.syllabify('rahoituserien')
        ['ra.hoi.tu.se.ri.en']  # incorrect