Skip to content

Commit

Permalink
readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
lukavdplas committed Aug 23, 2023
1 parent 9b899f4 commit 0cf25a5
Showing 1 changed file with 13 additions and 6 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Compound Splitter

[![DOI](https://zenodo.org/badge/282840038.svg)](https://zenodo.org/badge/latestdoi/282840038)

This is a basic wrapper for multiple Dutch compound splitters. The purpose of this wrapper is to:

- provide a unified API for multiple compound splitters. The package offers a simple socket server and a Flask application for this purpose.
Expand All @@ -20,28 +22,33 @@ As a baseline, we also include a "never" algorithm, which never splits.

## Installation

To install via pip:
### Installing with pip

`compound-splitters-nl` is available as a python package, which includes all the data for all included compound splitter methods. This complete package is too large to be registered on PyPI, but you can download the package from our [releases](https://github.com/UUDigitalHumanitieslab/compound-splitter/releases/).

The archived package can be installed via pip by installing the local file:

```bash
pip install compound-splitters-nl
pip install compound-splitters-nl-*.tar.gz
# or substitute with your file path
```

If you want to use the web API, you will need to install additional dependencies:

```bash
pip install compound-splitters-nl[web_api]
pip install compound-splitters-nl-*.tar.gz[web_api]
```

Alternatively, clone the source code repository and run installation with:
### Installing from source code

You can also clone the source code repository. In this case, you will still need to download and unpack the data needed for the compound splitter methods. Run installation with:

``` bash
pip install -r requirements.txt
python retrieve.py
python prepare.py
```

This will download and unpack all algorithms.

## Tests

``` bash
Expand Down

0 comments on commit 0cf25a5

Please sign in to comment.