loanpy 3.0.4
a linguistic toolkit for detecting old loanwords by predicting, evaluating and applying changes in horizontal and vertical lexical transfers
License: MIT
Requires Python: >=3.7
Keywords: linguistics,loanwords,language-contact,sound-change-applier

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.7893906.svg
   :target: https://doi.org/10.5281/zenodo.7893906
   :alt: the DOI

.. image:: https://dl.circleci.com/status-badge/img/gh/LoanpyDataHub/loanpy/tree/main.svg?style=svg
   :target: https://dl.circleci.com/status-badge/redirect/gh/LoanpyDataHub/loanpy/tree/main
   :alt: continuous integration status

.. image:: https://coveralls.io/repos/github/LoanpyDataHub/loanpy/badge.svg
   :target: https://coveralls.io/github/LoanpyDataHub/loanpy
   :alt: code coverage status

.. image:: https://readthedocs.org/projects/loanpy/badge/?version=latest
   :target: https://loanpy.readthedocs.io/en/latest/?badge=latest
   :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/loanpy.svg
  :target: https://pypi.org/project/loanpy/
  :alt: PyPI Latest Version

Intro
-----

LoanPy is a linguistic toolkit developed during the course of my PhD thesis
at the University of Vienna, providing solutions for various tasks in
historical and contact linguistics, such as:

- Mining correspondence patterns from etymological data on the level of
  phonology and phonotactics
- Predicting loanword adaptation (lateral/horizontal transfers) based on
  heuristics and etymological data
- Historical reconstruction of words (vertical transfers) based on
  etymological data
- Evaluating the quality of the predictive models
- Searching for potential (old) loanwords between two languages

This toolkit has been designed with ease of use and compatibility in mind,
offering a standalone, easy-to-setup, and cross-platform solution that works
with Python 3.7 or higher. 

Installation
------------

Latest stable version:

::

    $ pip install loanpy

Development version:

::

    $ pip install git+https://github.com/martino-vic/loanpy.git@main

Documentation
-------------

- `Read the docs <https://loanpy.readthedocs.io/en/latest/home.html>`_

Citation
--------

If you use loanpy 3 in your research or project, please cite the following:

::

    @misc{martinovic2023,
      author       = {Viktor Martinovi{\'c}},
      title        = {LoanpyDataHub/loanpy: Third stable release},
      month        = may,
      year         = 2023,
      publisher    = {Zenodo},
      version      = {3.0.0},
      doi          = {10.5281/zenodo.7893906},
      url          = {https://doi.org/10.5281/zenodo.7893906}
    }

License
-------

LoanPy is released under the MIT License.

Compatible Input Data
---------------------

LoanPy supports the following datasets:

- `streitberggothic <https://github.com/LoanpyDataHub/streitberggothic>`_,
- `koeblergothic <https://github.com/LoanpyDataHub/koeblergothic>`_
- `gerstnerhungarian <https://github.com/LoanpyDataHub/gerstnerhungarian>`_
- `ronataswestoldturkic <https://github.com/LoanpyDataHub/ronataswestoldturkic>`_

Main Changes Compared to Version 2
----------------------------------

- Standalone: No external dependencies needed.
- Easy setup: Just download or clone the repository and start using it.
- Cross-platform: Works on any platform that supports Python.
- Python Compatibility: Works with Python 3.7 or higher.
- CLDF Integration: Fully compatible with `CLDF data standards <https://cldf.clld.org/>`_.