Difference between revisions of "Installation"

From Apertium
Jump to navigation Jump to search
(Given the page title, I think this information should be included...)
 
(18 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
[[Installation (français)|En français]]
 
[[Installation (français)|En français]]
 
 
{{Main page header}}
 
{{Main page header}}
   
  +
= To try Apertium =
== If you just want a simple way to translate offline ==
 
  +
== Online ==
Most of the applications below are simple two-box "choose a translation pair and start typing" graphic user interfaces,
 
  +
  +
* https://apertium.org is the official site, and offers all the released language pairs
  +
  +
Alternative installations:
  +
  +
* http://aplica.prompsit.com/ – Prompsit is a company heavily involved in development of the Apertium platform, and also offers a simple web interface to the released language pairs
  +
* https://www.softcatala.org/traductor/ – Softcatalà works on Catalan localisation and offers the Catalan←→* language pairs here
  +
* http://jorgal.uit.no/ – the University of Tromsø works on Saami language pairs; this site runs the latest in-development version of Northern Saami→Norwegian Bokmål
  +
* http://gtweb.uit.no/tolkimine/ – another site by University of Tromsø, the latest in-development version of Estonian←→Finnish
  +
* https://softaragones.org/traductor/ - Apertium Luengas d'Aragón - Softaragonés offers here the language pairs between the three native languages of Aragon: Aragonese - Catalan - Spanish
  +
  +
== Offline, desktop ==
  +
  +
There are several applications which work from the desktop without full installation.
  +
  +
The easiest solution for Windows and Mac users is [[Apertium Simpleton UI]]. You can install translator packages from within that program (though only the pairs that are on the website, not the "in development" pairs).
   
  +
[[Tools#Tools for users / translators]] has more graphical user interfaces for translators, though you'll have to install translator packages separately.
* [[Apertium-caffeine]] is written in Java and '''multi-platform'''.
 
   
  +
To install translator packages, see the following section [[#For those who want to install Apertium locally, and developers]]
* Written in QT and C++ for '''Windows''' or '''Mac OS X''', the [[Apertium Simpleton UI]].
 
   
  +
== Offline, mobile ==
* '''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.
 
   
  +
* https://play.google.com/store/apps/details?id=org.apertium.android – Simple offline translations for Android (not all released pairs supported yet), see [[Apertium Android]]
* '''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.
 
  +
* http://www.mitzuli.com/en/ – More fully-featured offline translations app for Android (not all released pairs supported yet), see [[Mitzuli]]
  +
* https://www.softcatala.org/programes/traductor-softcatala/ – Catalan translation app for Android/iPhone
   
  +
= For those who want to install Apertium locally, and developers=
See [[Tools]] for more graphical user interfaces, services, plugins, etc.
 
  +
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.
   
  +
Packaged or compiled, these tools can be installed as one unit. From here on, we call them 'Apertium core'.
=== If you want a simple way to see how Apertium works ===
 
  +
</ref> and language data on your system (developers may also want to consider their operating environment<ref>
* [[Apertium-viewer]] is a Java-based '''multi-platform''' UI to view and edit the output of the various stages of an Apertium translation.
 
  +
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.
   
  +
In no way does this mean that the Apertium project favours this platform.
=== Installing extra languages in tools ===
 
  +
</ref>).
Several tools can download language pairs from the web. Some can also install their downloaded language pairs.
 
   
  +
==Installing: a summary==
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.
 
  +
Most people will need Apertium core, after which they may choose to install precompiled language data or development language data.
   
  +
===Install Apertium Core by packaging/virtual environment===
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).
 
  +
Most people will need to install Apertium core.
  +
* Linux systems: [[Install Apertium core using packaging]]
  +
* Windows 10:
  +
** WSL: First follow https://docs.microsoft.com/en-us/windows/wsl/install-win10 then continue with [[Install Apertium core using packaging]]
  +
* Windows < 10: [[Apertium VirtualBox]]
 
* macOS: [[Prerequisites for Mac OS X]] or [[Apertium VirtualBox]]
   
== If you want to add language data / do more advanced stuff ==
+
=== For translators: Install language data/dictionaries/pairs from repositories ===
  +
Translators will probably want to [[install language data using packaging]], including hints about the Apertium package repository.
   
  +
=== For language developers: Install language data/dictionaries/pairs by compiling ===
'''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:
 
  +
Language developers may want to do one of the following:
# Install prerequisites specific to your operating system:
 
  +
* Start a new language pair: [[How to bootstrap a new pair]]
#*[[Prerequisites for nix|*nix (in general)]]
 
  +
* Work on an existing language pair: [[Install language data by compiling]]
#*[[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]] (untested)
 
#*[[Prerequisites for Slackware|Slackware]]
 
#*[[Apertium_on_SliTaz|SliTaz]]
 
#*[[Apertium_on_Mageia|Mageia]]
 
# 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==
   
  +
===Installing Apertium core by compiling===
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>
 
   
  +
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]]<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.
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.
 
   
  +
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>
   
  +
= Notes =
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.
 
  +
<references/>
   
== Installation Videos ==
+
= Installation Videos =
   
 
Most of these videos have been produced by Google Code-In students.
 
Most of these videos have been produced by Google Code-In students.

Latest revision as of 19:38, 18 October 2020

En français

InstallationResourcesContactDocumentationDevelopmentTools

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


To try Apertium[edit]

Online[edit]

Alternative installations:

  • http://aplica.prompsit.com/ – Prompsit is a company heavily involved in development of the Apertium platform, and also offers a simple web interface to the released language pairs
  • https://www.softcatala.org/traductor/ – Softcatalà works on Catalan localisation and offers the Catalan←→* language pairs here
  • http://jorgal.uit.no/ – the University of Tromsø works on Saami language pairs; this site runs the latest in-development version of Northern Saami→Norwegian Bokmål
  • http://gtweb.uit.no/tolkimine/ – another site by University of Tromsø, the latest in-development version of Estonian←→Finnish
  • https://softaragones.org/traductor/ - Apertium Luengas d'Aragón - Softaragonés offers here the language pairs between the three native languages of Aragon: Aragonese - Catalan - Spanish

Offline, desktop[edit]

There are several applications which work from the desktop without full installation.

The easiest solution for Windows and Mac users is Apertium Simpleton UI. You can install translator packages from within that program (though only the pairs that are on the website, not the "in development" pairs).

Tools#Tools for users / translators has more graphical user interfaces for translators, though you'll have to install translator packages separately.

To install translator packages, see the following section #For those who want to install Apertium locally, and developers

Offline, mobile[edit]

For those who want to install Apertium locally, and developers[edit]

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[edit]

Most people will need Apertium core, after which they may choose to install precompiled language data or development language data.

Install Apertium Core by packaging/virtual environment[edit]

Most people will need to install Apertium core.

For translators: Install language data/dictionaries/pairs from repositories[edit]

Translators will probably want to install language data using packaging, including hints about the Apertium package repository.

For language developers: Install language data/dictionaries/pairs by compiling[edit]

Language developers may want to do one of the following:

Alternatives[edit]

Installing Apertium core by compiling[edit]

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[edit]

  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[edit]

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