From 27e33c593e59fcc01393d02f335985a741d861d6 Mon Sep 17 00:00:00 2001 From: Luka Date: Fri, 20 Dec 2019 11:35:04 +0100 Subject: [PATCH] Adding files for windows and modifying README.md - adding instructions for windows --- README.md | 26 +++++++++++++++++++++----- install.bat | 1 + run.bat | 2 ++ 3 files changed, 24 insertions(+), 5 deletions(-) create mode 100755 install.bat create mode 100755 run.bat diff --git a/README.md b/README.md index 959ac34..d052438 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,28 @@ -# STARK: a tool for statisical analysis of dependency-parsed corpora +# STARK: a tool for statistical analysis of dependency-parsed corpora STARK is a python-based command-line tool for extraction of dependency trees from parsed corpora based on various user-defined criteria. It is primarily aimed at processing corpora based on the [Universal Dependencies](https://universaldependencies.org/) annotation scheme, but it also takes any other corpus in the [CONLL-U](https://universaldependencies.org/format.html) format as input. +## Windows installation and execution +### Installation +Install Python 3 on your system (https://www.python.org/downloads/). + +Download pip installation file (https://bootstrap.pypa.io/get-pip.py) and install it by double clicking on it. + +Install other libraries necessary for running by going into program directory and double clicking on `install.bat`. If windows defender is preventing execution of this file you might have to unblock that file by `right-clicking on .bat file -> Properties -> General -> Security -> Select Unblock -> Select Apply`. + +### Execution +Set up search parameters in `.ini` file. + +Execute extraction by running `run.bat` (in case it is blocked repeat the same procedure as for `install.bat`). +Optionally modify run.bat by pointing it to another .ini file. This can be done by editing run.bat file (changing parameter --config_file). + + ## Linux installation and execution ### Installation -Install python 3 on your sistem. +Install Python 3 on your system (https://www.python.org/downloads/). -Run the following commands in terminal: +Install pip and other libraries required by program, by running the following commands in terminal: ```bash +sudo apt install python3-pip cd pip3 install -r requirements.txt ``` @@ -51,7 +67,7 @@ The type of trees to be extracted can be defined through several parameters in t - `lines_threshold`: maximum number of trees in the output ## Output -The tool returns the resulting list of all relevant trees in the form of a tab-separated `.tsv` file with information on the tree structure, its frequency and other relevant information in relation to specific parameter settings. The tool does not support any data visualization, however, the output structure of the tree is directly trasnferable to the [Dep_Search](http://bionlp-www.utu.fi/dep_search/) concordancing service giving access to specific examples in many corpora. +The tool returns the resulting list of all relevant trees in the form of a tab-separated `.tsv` file with information on the tree structure, its frequency and other relevant information in relation to specific parameter settings. The tool does not support any data visualization, however, the output structure of the tree is directly transferable to the [Dep_Search](http://bionlp-www.utu.fi/dep_search/) concordancing service giving access to specific examples in many corpora. ## Credits This program was developed by Luka Krsnik in collaboration with Kaja Dobrovoljc and Marko Robnik Šikonja and with financial support from [CLARIN.SI](https://www.clarin.si/). @@ -59,4 +75,4 @@ This program was developed by Luka Krsnik in collaboration with Kaja Dobrovoljc drawing drawing drawing -drawing \ No newline at end of file +drawing diff --git a/install.bat b/install.bat new file mode 100755 index 0000000..1d5a3fc --- /dev/null +++ b/install.bat @@ -0,0 +1 @@ +py -m pip install -r requirements.txt & \ No newline at end of file diff --git a/run.bat b/run.bat new file mode 100755 index 0000000..f019243 --- /dev/null +++ b/run.bat @@ -0,0 +1,2 @@ +py dependency-parsetree.py --config_file=config.ini & +@pause \ No newline at end of file