Package: camel-tools
IntroductionCAMeL Tools is  suite of Arabic natural language processing tools developed by
theCAMeL LabatNew York University Abu Dhabi.Please useGitHub Issuesto report a bug or if you need help using CAMeL Tools.InstallationYou will need Python 3.7 - 3.10 (64-bit) as well asthe Rust compilerinstalled.Linux/macOSInstall using pippipinstallcamel-tools# or run the following if you already have camel_tools installedpipinstallcamel-tools--upgradeInstall from source# Clone the repogitclonehttps://github.com/CAMeL-Lab/camel_tools.gitcdcamel_tools# Install from sourcepipinstall.# or run the following if you already have camel_tools installedpipinstall--upgrade.Installing dataTo install the datasets required by CAMeL Tools components run one of the
following:# To install all datasetscamel_data-iall# or just the datasets for morphology and MLE disambiguation onlycamel_data-ilight# or just the default datasets for each componentcamel_data-idefaultsSeeAvailable Packagesfor a list of all available datasets.By default, data is stored in~/.camel_tools.
Alternatively, if you would like to install the data in a different location,
you need to set theCAMELTOOLS_DATAenvironment variable to the desired
path.Add the following to your.bashrc,.zshrc,.profile,
etc:exportCAMELTOOLS_DATA=/path/to/camel_tools_dataWindowsNote:CAMeL Tools has been tested on Windows 10. The Dialect Identification
component is not available on Windows at this time.Install using pippipinstallcamel-tools-fhttps://download.pytorch.org/whl/torch_stable.html# or run the following if you already have camel_tools installedpipinstall--upgrade-fhttps://download.pytorch.org/whl/torch_stable.htmlcamel-toolsInstall from source# Clone the repogitclonehttps://github.com/CAMeL-Lab/camel_tools.gitcdcamel_tools# Install from sourcepipinstall-fhttps://download.pytorch.org/whl/torch_stable.html.pipinstall--upgrade-fhttps://download.pytorch.org/whl/torch_stable.html.Installing dataTo install the data packages required by CAMeL Tools components, run one of the
following commands:# To install all datasetscamel_data-iall# or just the datasets for morphology and MLE disambiguation onlycamel_data-ilight# or just the default datasets for each componentcamel_data-idefaultsSeeAvailable Packagesfor a list of all available datasets.By default, data is stored inC:\Users\your_user_name\AppData\Roaming\camel_tools.
Alternatively, if you would like to install the data in a different location,
you need to set theCAMELTOOLS_DATAenvironment variable to the desired
path. Below are the instructions to do so (on Windows 10):Press theWindowsbutton and typeenv.Click onEdit the system environment variables (Control panel).Click on theEnvironment Variables…button.Click on theNew…button under theUser variablespanel.TypeCAMELTOOLS_DATAin theVariable nameinput box and the
desired data path inVariable value. Alternatively, you can browse for the
data directory by clicking on theBrowse Directory…button.ClickOKon all the opened windows.DocumentationTo get started, you can follow alongthe Guided Tourfor a quick overview of the components provided by CAMeL Tools.You can find thefull online documentation herefor both
the command-line tools and the Python API.Alternatively, you can build your own local copy of the documentation as
follows:# Install dependenciespipinstallsphinxrecommonmarksphinx-rtd-theme# Go to docs subdirectorycddocs# Build HTML docsmakehtmlThis should compile all the HTML documentation in todocs/build/html.CitationIf you find CAMeL Tools useful in your research, please citeour paper:@inproceedings{obeid-etal-2020-camel,title="{CAM}e{L} Tools: An Open Source Python Toolkit for {A}rabic Natural Language Processing",author="Obeid, Ossama  and
      Zalmout, Nasser  and
      Khalifa, Salam  and
      Taji, Dima  and
      Oudah, Mai  and
      Alhafni, Bashar  and
      Inoue, Go  and
      Eryani, Fadhl  and
      Erdmann, Alexander  and
      Habash, Nizar",booktitle="Proceedings of the 12th Language Resources and Evaluation Conference",month=may,year="2020",address="Marseille, France",publisher="European Language Resources Association",url="https://www.aclweb.org/anthology/2020.lrec-1.868",pages="7022--7032",abstract="We present CAMeL Tools, a collection of open-source tools for Arabic natural language processing in Python. CAMeL Tools currently provides utilities for pre-processing, morphological modeling, Dialect Identification, Named Entity Recognition and Sentiment Analysis. In this paper, we describe the design of CAMeL Tools and the functionalities it provides.",language="English",ISBN="979-10-95546-34-4",}LicenseCAMeL Tools is available under the MIT license.
See theLICENSE filefor more info.ContributeIf you would like to contribute to CAMeL Tools, please read theCONTRIBUTE.rstfile.ContributorsOssama ObeidGo InoueBashar AlhafniSalam KhalifaDima TajiNasser ZalmoutNizar Habash