Difference between revisions of "Installation"

From Apertium
Jump to navigation Jump to search
(Separate macOS)
(31 intermediate revisions by 8 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 =
'''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:
 
  +
You can go online to the [https://apertium.org front page] :)
# Install prerequisites specific to your operating system:
 
  +
#*[[Prerequisites for Debian|Ubuntu / Debian / other Debian-based]]
 
  +
There are several applications which work from the desktop without full installation. For these and more graphical user interfaces, services, plugins, etc. goto [[Tools]].
#*[[Prerequisites for RPM|RHEL / CentOS / Fedora / OpenSUSE]]
 
  +
#*[[Prerequisites for openSUSE|openSUSE]]
 
  +
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.
#*[[Prerequisites for Mac OS X|Mac OS X]]
 
  +
#*[[Prerequisites for Arch Linux|Arch Linux]]
 
  +
= For those who want to install Apertium locally, and developers=
#*[[Prerequisites for Fedora|Fedora]]
 
  +
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.
#*[[Prerequisites for Gentoo|Gentoo]]
 
  +
#*[[Prerequisites for FreeBSD|FreeBSD]] (untested)
 
  +
Packaged or compiled, these tools can be installed as one unit. From here on, we call them 'Apertium core'.
#*<small>([[Apertium on Mandriva|Mandriva]] seems to have some trouble)</small>
 
  +
</ref> and language data on your system (developers may also want to consider their operating environment<ref>
# Install apertium and related packages from SVN.
 
  +
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.
#*Follow [[Minimal installation from SVN]], this should be general enough to cover all the above operating systems.
 
  +
# Fix any problems :)
 
  +
In no way does this mean that the Apertium project favours this platform.
#* Search the page [[Installation Troubleshooting]] for your error message.
 
  +
</ref>).
  +
  +
==Installing: a summary==
  +
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===
  +
Most people will need to install Apertium core.
  +
* Linux systems and WSL: [[Install Apertium core using packaging]]
  +
* Windows: [[Apertium VirtualBox]]
 
* macOS: [[Prerequisites for Mac OS X]] or [[Apertium VirtualBox]]
  +
  +
=== 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 ===
  +
Language developers may want to do one of the following:
  +
* Start a new language pair: [[How to bootstrap a new pair]]
  +
* Work on an existing language pair: [[Install language data by compiling]]
   
  +
==Alternatives==
   
  +
===Installing Apertium core by compiling===
For '''Windows''' users, 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 '''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 =
   
  +
Most of these videos have been produced by Google Code-In students.
'''Android''' users can download the [https://play.google.com/store/apps/details?id=org.apertium.android Apertium offline translator app] (more info at [[Apertium Android]]) or [http://www.mitzuli.com Mitzuli].
 
   
  +
* Using Apertium Virtualbox on Windows: https://youtu.be/XCUWMCJkRDo
  +
* Installing Apertium on Ubuntu (Romanian, English): https://www.youtube.com/watch?v=vy7rWy2u_m0
  +
* Ubuntu'ya Apertium Kurulumu / Apertium installation on Ubuntu (Turkish, English subtitles): https://www.youtube.com/watch?v=I__-BiQe7zg
  +
* Apertium on Slitaz (English): https://youtu.be/fCluA03oIXY
  +
* How to Install Apertium On Macintosh: https://www.youtube.com/watch?v=oSuovCCsa68
   
 
[[Category:Installation]]
 
[[Category:Installation]]

Revision as of 09:21, 3 August 2017

En français

InstallationResourcesContactDocumentationDevelopmentTools

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


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 Apertium core, after which they may choose to install precompiled language data or development language data.

Install Apertium Core by packaging/virtual environment

Most people will need to install Apertium core.

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

Language developers may want to do one of the following:

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.