Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rezKamal/ckb-spellchecker

Apertium rule-based language package for Sorani Kurdish.
https://github.com/rezKamal/ckb-spellchecker

Last synced: 28 days ago
JSON representation

Apertium rule-based language package for Sorani Kurdish.

Awesome Lists containing this project

README

        

This project belongs to Rezhwan Kamal, a native speaker of Sorani
Kurdish. It is a combination of a ckb lexd transducer and spell checker. It is
licensed under the MIT License. A relevant Wikipedia entry can be found [here](https://wikis.swarthmore.edu/ling073/User:Rkamal1/Final_project).
The graphic poster detailing the project is also contained in this repo. The
info that follows is from Apertium.

Sorani Kurdish: `ckb-spellchecker`
===============================================================================

This is an Apertium monolingual language package for Sorani Kurdish. What
you can use this language package for:

* Morphological analysis of Sorani Kurdish
* Morphological generation of Sorani Kurdish
* Part-of-speech tagging of Sorani Kurdish
* Spell-checking text in Sorani Kurdish

Requirements
-------------------------------------------------------------------------------

You will need the following software installed:

* autoconf
* automake
* pkg-config
* lttoolbox (>= 3.5.1)
* apertium (>= 3.6.1)
* vislcg3 (>= 1.3.1)
* hfst (>= 3.15.1)
* lexd (>= 0.0.1)

If this does not make any sense, we recommend you look at: www.apertium.org.

Compiling
-------------------------------------------------------------------------------

Given the requirements being installed, you should be able to just run:

```bash
$ autoreconf -fvi
$ ./configure
$ make
```

You can use `./autogen.sh` instead of `autoreconf` and `./configure` if you're compiling
from source.

If you're doing development, you don't have to install the data, you
can use it directly from this directory.

If you are installing this language package as a prerequisite for an
Apertium translation pair, then do (typically as root / with sudo):

```bash
$ make install
```

You can use a `--prefix` with `./configure` to install as a non-root user,
but make sure to use the same prefix when installing the translation
pair and any other language packages.

If any of this doesn't make sense or doesn't work, see https://wiki.apertium.org/wiki/Install_language_data_by_compiling

Testing
-------------------------------------------------------------------------------

If you are in the source directory after running make, the following
commands should work:

```console
$ echo "TODO: test sentence" | apertium -d . ckb-morph
TODO: test analysis result

$ echo "TODO: test sentence" | apertium -d . ckb-tagger
TODO: test tagger result
```

Files and data
-------------------------------------------------------------------------------

* [`apertium-ckb.ckb.lexd`](apertium-ckb.ckb.lexd) - Morphotactic dictionary
* [`apertium-ckb.ckb.twol`](apertium-ckb.ckb.twol) - Morphophonological rules
* [`apertium-ckb.ckb.rlx`](apertium-ckb.ckb.rlx) - Constraint Grammar disambiguation rules
* [`apertium-ckb.post-ckb.dix`](apertium-ckb.post-ckb.dix) - Post-generator
* [`ckb.prob`](ckb.prob) - Tagger model
* [`apertium-ckb.ckb.spellrelax`](apertium-ckb.ckb.spellrelax) - Typographical variance rules
* [`apertium-ckb.ckb.udx`](apertium-ckb.ckb.udx) - Mappings from Apertium tags to Universal Dependencies features
* [`modes.xml`](modes.xml) - Translation modes

For more information
-------------------------------------------------------------------------------

* http://wiki.apertium.org/wiki/Installation
* http://wiki.apertium.org/wiki/apertium-ckb
* http://wiki.apertium.org/wiki/Using_an_lttoolbox_dictionary

Help and support
-------------------------------------------------------------------------------

If you need help using this language pair or data, you can contact:

* Mailing list: [email protected]
* IRC: `#apertium` on irc.freenode.net (irc://irc.freenode.net/#apertium)

See also the file [`AUTHORS`](AUTHORS), included in this distribution.