1. Checking the requirements
Before following the instructions below, please check that you have installed all the requirements according to your Operating System:
Once the requirements are installed, choose one installation method, from GIT or from release, and follow the instructions below. As the code evolves fast and releases are not that frequent, we HIGHLY recommend you to use the GIT version.
2. Downloading from the GIT repository (RECOMMENDED)
Open a command line terminal in Linux, Mac OS or Windows through Cygwin. To download the latest mwetoolkit version, just get it from our Gitlab repository using the following command:
git clone --depth=1 "https://gitlab.com/mwetoolkit/mwetoolkit.git"
It might take some time to download all the files. GIT is a version control system, meaning you can upgrade to the latest development version of the mwetoolkit at any time simply by running
git pull in the mwetoolkit folder. When the download is complete, jump to step 3: installation
WARNING: The sourceforge SVN repository was migrated on Sep 14, 2015 to a Gitlab GIT repository. Any checkout done before this date will be obsolete and no more commits will be made to the old repository:
svn://svn.code.sf.net/p/mwetoolkit/code/ Please, erase your mwetoolkit folder and run the
git clone command above to obtain an up-to-date version that includes the latest developments and bug fixes.
2b. Downloading a .zip release
Alternatively, the toolkit is also availaible as a stable release. However, as the code evolves fast, we HIGHLY recommend you to use the GIT version instead (see above).
You can download and unzip the toolkit by clicking here, or type the commands below in the command line:
wget -O mwetoolkit.zip "https://gitlab.com/mwetoolkit/mwetoolkit/repository/archive.zip?ref=v1.1"
3. Installing the toolkit
Navigate to the main folder and compile the C libraries used by the toolkit. You can use the commands below:
If you used the "release" download method, you need to append the version number to the first command, e.g.
cd mwetoolkit_0.6. Do not worry if there are warning messages, they are harmless. However, if there are ERROR messages, send us an email.
If you do not run this command, or if the command fails to compile the libraries, the toolkit will still work. However, it will use a Python version of the indexing and counting programs (slower and possibly obsolete). This may be OK for small corpora.
4. Testing your installation
test folder contains regression tests for most scripts. Navigate to this folder and then call the script
Should one of the tests fail, please contact us sending a copy of the output and a brief description of your configurations (operating system, version, machine). In some architectures (Mac OS), the test appears to fail because of floating point rounding differences in the last digits. This can be checked in the test log files and safely ignored.
Failed tests do not prevent you from using the mwetoolkit normally :-)