Apertium has moved from SourceForge to GitHub.
If you have any questions, please come and talk to us on #apertium on irc.freenode.net or contact the GitHub migration team.

Installation

From Apertium
(Difference between revisions)
Jump to: navigation, search
(If you want to add language data / do more advanced stuff)
(new page...)
Line 1: Line 1:
 
[[Installation (français)|En français]]
 
[[Installation (français)|En français]]
 
 
{{Main page header}}
 
{{Main page header}}
   
== If you just want a simple way to translate offline ==
+
== To try Apertium ==
Most of the applications below are simple two-box "choose a translation pair and start typing" graphic user interfaces,
+
You can go online to the [https://apertium.org front page] :)
  +
  +
There are several applications which work from the desktop without full installation. For these and more graphical user interfaces, services, plugins, etc. goto [[Tools]].
  +
  +
If you would like install instructions for 'Apertium viewer', 'apy' (the Apertium server) etc. got to [[Tools]]. The install instructions can be found with the tool descriptions.
  +
   
* [[Apertium-caffeine]] is written in Java and '''multi-platform'''.
 
   
* Written in QT and C++ for '''Windows''' or '''Mac OS X''', the [[Apertium Simpleton UI]].
+
== For those who want to install Apertium locally, and developers==
  +
How to install Apertium core<ref>Apertium is a big system. There are many plugins, scripts, and extension projects. The core, the code which translates, is a multi-step set of tools joined by a stream format and, nowadays, invoked by scripts called 'modes'. You may also see the names 'lt-toolbox'/'lt-tools', 'apertium-lex-tools', and the simple title 'apertium'. These refer to groupings of the tools.
   
* '''Android''' users can download [https://play.google.com/store/apps/details?id=org.apertium.android|Apertium offline translator app] (more info at [[Apertium Android]]), or the more advanced [http://www.mitzuli.com Mitzuli] app.
+
Packaged or compiled, these tools can be installed as one unit. From here on, we call them 'Apertium core'.
  +
</ref> and language data on your system (developers may also want to consider their operating environment<ref>
  +
Apertium is written to be platform-independent. However, it can be difficult to maintain platform-independence over a project this wide. If you intend to do something deep with Apertium, you will gain more help from the tools if you use the [http://ubuntu.com Ubuntu], or a similar Debian-based, operating system.
   
* '''Unix''' users, e.g. GNU/Linux or BSD users, do not have a currently-maintained UI. However, [[Apertium tolk]], a Python/DBus application, is in repositories and will install and run ok.
+
In no way does this mean that the Apertium project favours this platform.
  +
</ref>).
   
See [[Tools]] for more graphical user interfaces, services, plugins, etc.
 
   
=== If you want a simple way to see how Apertium works ===
+
===Installing: a summary===
* [[Apertium-viewer]] is a Java-based '''multi-platform''' UI to view and edit the output of the various stages of an Apertium translation.
+
Most people will need to,
   
=== Installing extra languages in tools ===
+
====Install Apertium Core by packaging/virtual environment====
Several tools can download language pairs from the web. Some can also install their downloaded language pairs.
+
* Linux systems: [[Install Apertium core using packaging]]
  +
* Windows and Apple systems: [[Apertium VirtualBox]]
   
Some tools, including those that do not download language pairs, seek language pairs in known places. For example, a Debian-packaged version of 'apertium-tolk' seeks pairs in '/usr/share/apertium'. This is where Debian installs pre-packaged pairs, and 'apertium-tolk' can find them. If language pairs are placed in this folder (not necessarily by the packaging system, though you will be told not to do this), 'apertium-tolk' will load them.
+
==== For translators: Install language data/dictionaries/pairs from repositories ====
  +
[[Install language data using packaging]], including hints about the Apertium package repository.
   
The language pairs offered by the tools are those cleared as stable or developed. These pairs have been moved to subversion 'trunk'. There are many more language pairs available, but in various stages of development. However intriguing they may seem, a person using a GUI will have little interest in these (some pairs will not run without custom build environments).
+
==== For language developers: Install language data/dictionaries/pairs by compiling ====
  +
* Start a new language pair: [[How to bootstrap a new pair]]
  +
* Work on an existing language pair: [[Install language data by compiling]]
   
== If you want to add language data / do more advanced stuff ==
 
   
'''Unix''' users (GNU/Linux, Mac, BSD) who wish to hack on Apertium should follow these three stages to installing the core packages and language data:
 
# Install prerequisites specific to your operating system:
 
#*[[Prerequisites for nix|*nix (in general)]]
 
#*[[Prerequisites for Debian|Ubuntu / Debian / other Debian-based]]
 
#*[[Prerequisites for RPM|RHEL / CentOS / Fedora / OpenSUSE]]
 
#*[[Prerequisites for openSUSE|openSUSE]]
 
#*[[Prerequisites for Mac OS X|Mac OS X]]
 
#*[[Prerequisites for Arch Linux|Arch Linux]]
 
#*[[Prerequisites for Gentoo|Gentoo]]
 
#*[[Prerequisites for FreeBSD|FreeBSD]]
 
#*[[Prerequisites for Slackware|Slackware]]
 
#*[[Apertium_on_SliTaz|SliTaz]]
 
#*[[Apertium_on_Mageia|Mageia]]
 
#*[[Apertium_on_Alpine_Linux|Alpine Linux]]
 
# Install apertium and related packages from SVN.
 
#*Follow [[Minimal installation from SVN]], this should be general enough to cover all the above operating systems.
 
# Fix any problems :)
 
#* Search the page [[Installation Troubleshooting]] for your error message.
 
   
  +
===Alternatives===
   
For '''Windows''' users who wish to hack on Apertium, the best method is to download the [[Apertium VirtualBox]], which lets you run a Unix in your Windows, and comes with Apertium from SVN (and one language pair) pre-installed. Once you've got the VirtualBox, you can install more language pairs as shown in [[Minimal installation from SVN]]. <small>Alternatively, you can compile it for Windows using Cygwin; documentation for how to compile on Windows manually is at [[Apertium on Windows]]; there is also a script at [[Apertium guide for Windows users]], but it is currently out-of-date and in need of updating.</small>
+
====Installing Apertium core by compiling====
   
  +
Apertium maintains a package repository that is up-to-date and reliable. If you do not want to work in core, or develop languages, please use either packaging or a virtual environment. The packages stay up-to-date and are stable. A compile will waste your time.
   
Some language pairs require extra packages like '''Constraint Grammar''' (vislcg3) or '''HFST''' in addition to apertium/lttoolbox/apertium-lex-tools. For most systems, the "Prerequisites" pages will show how to install these through your package manager, but see the section on [[Apertium and Constraint Grammar#Installing_VISL_CG3|installing vislcg3]] and [[HFST]], respectively if you're on a not-yet-supported system. You can tell if a package requires CG if it has an .rlx file, and HFST if it has a .lexc file.
+
However, if you are planning to work on Apertium core, or have an operating system not covered above, go right ahead, [[Install Apertium core by compiling]]<ref name="about installing">Most people know the word 'install'. It means 'put code in my operating system'. When developing, it is not usual to fully 'install'. You get the code working enough to get results.
   
  +
This is relevant to Apertium, which needs a rapid cycle for re-compiles. If you follow instructions to compile code, you will be discouraged from 'installing' builds. When we use the word 'install', we mean 'get code working on my computer'.</ref>
   
There are released tarball packages on the [http://www.apertium.org/?id=downloading official download page]. These are meant for packagers, and '''advanced users who are not planning to develop''' on apertium. These are installed like the SVN packages, except you use <code>./configure</code> instead of <code>./autogen.sh</code>. Many systems now also have pre-packaged apertium language pairs, but the official Debian/MacPorts/… repositories are often quite outdated compared to the SVN versions – use TinoDidriksen's nightly packages as instructed in the "Prerequisites" pages above.
+
== Notes ==
  +
<references/>
   
 
== Installation Videos ==
 
== Installation Videos ==

Revision as of 16:51, 27 April 2017

En français

InstallationResourcesContactDocumentationDevelopmentTools

Gnome-home.png Home PageBugs.png BugsInternet.png WikiGaim.png Chat


Contents

To try Apertium

You can go online to the front page :)

There are several applications which work from the desktop without full installation. For these and more graphical user interfaces, services, plugins, etc. goto Tools.

If you would like install instructions for 'Apertium viewer', 'apy' (the Apertium server) etc. got to Tools. The install instructions can be found with the tool descriptions.


For those who want to install Apertium locally, and developers

How to install Apertium core[1] and language data on your system (developers may also want to consider their operating environment[2]).


Installing: a summary

Most people will need to,

Install Apertium Core by packaging/virtual environment

For translators: Install language data/dictionaries/pairs from repositories

Install language data using packaging, including hints about the Apertium package repository.

For language developers: Install language data/dictionaries/pairs by compiling


Alternatives

Installing Apertium core by compiling

Apertium maintains a package repository that is up-to-date and reliable. If you do not want to work in core, or develop languages, please use either packaging or a virtual environment. The packages stay up-to-date and are stable. A compile will waste your time.

However, if you are planning to work on Apertium core, or have an operating system not covered above, go right ahead, Install Apertium core by compiling[3]

Notes

  1. Apertium is a big system. There are many plugins, scripts, and extension projects. The core, the code which translates, is a multi-step set of tools joined by a stream format and, nowadays, invoked by scripts called 'modes'. You may also see the names 'lt-toolbox'/'lt-tools', 'apertium-lex-tools', and the simple title 'apertium'. These refer to groupings of the tools. Packaged or compiled, these tools can be installed as one unit. From here on, we call them 'Apertium core'.
  2. Apertium is written to be platform-independent. However, it can be difficult to maintain platform-independence over a project this wide. If you intend to do something deep with Apertium, you will gain more help from the tools if you use the Ubuntu, or a similar Debian-based, operating system. In no way does this mean that the Apertium project favours this platform.
  3. Most people know the word 'install'. It means 'put code in my operating system'. When developing, it is not usual to fully 'install'. You get the code working enough to get results. This is relevant to Apertium, which needs a rapid cycle for re-compiles. If you follow instructions to compile code, you will be discouraged from 'installing' builds. When we use the word 'install', we mean 'get code working on my computer'.

Installation Videos

Most of these videos have been produced by Google Code-In students.

Personal tools