Difference between revisions of "Pair viewer"

From Apertium
Jump to navigation Jump to search
Line 1: Line 1:
The Apertium '''Pairviewer''' is a HTML5 tool that depicts all Apertium [[list of language pairs|language pairs]] in an interactive graph initially developed sometime before the [[GCI|Google Code-In]] 2013. Its source code can be [https://github.com/apertium/pairviewer found on GitHub] and a demonstration is available [http://ilazki.thinkgeek.co.uk/~firespeaker/pairviewer/apertium.html here].
+
The Apertium '''Pairviewer''' is a HTML5/[https://d3js.org/ D3.js] tool that depicts all Apertium [[list of language pairs|language pairs]] in an interactive graph initially developed sometime before the [[GCI|Google Code-In]] 2013. Its source code can be [https://github.com/apertium/pairviewer found on GitHub] and an online demonstration is available [http://ilazki.thinkgeek.co.uk/~firespeaker/pairviewer/apertium.html here].
   
 
== Setting up Pairviewer locally ==
 
== Setting up Pairviewer locally ==
===Clone the git repository'''===
+
===Clone the git repository===
Run <code>git clone https://github.com/apertium/pairviewer.git</code>
+
Enter into the folder you want it to be in and download [https://github.com/apertium/pairviewer the whole program] by running <pre>git clone https://github.com/apertium/pairviewer.git</pre>
   
===Set up local server with Python===
+
===Set up a localhost with Python===
  +
You need to set up a [https://en.wikipedia.org/wiki/Localhost localhost] server before you can locally run Pairviewer.
''First'', make sure that you have Python installed on your system (you can do this by running <code>python -v</code>). Then, if what you have is Python 3, run <code>python3 -m http.server</code> Otherwise (i.e. you have Python 2), run <code>python -m SimpleHTTPServer</code>.
 
  +
  +
''First'', check whether you have Python installed on your system and if so, what version(s) it is. Install preferably the latest one (Python 3) if it had not been done already.
  +
<pre>python -v</pre>
  +
  +
Then make sure to enter the folder of the git repository you have cloned.
  +
  +
If you have is Python 3, run:
  +
<pre>python3 -m http.server</pre>
  +
  +
Otherwise, if you do have Python 2, run:
  +
<pre>python -m SimpleHTTPServer</pre>
  +
  +
You should see something like this on your terminal window.
  +
<pre>Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) <---- copy-paste this URL!</pre>
   
 
===Open on browser===
 
===Open on browser===
  +
Paste in your localhost address (e.g. <nowiki>http://0.0.0.0:80000/</nowiki>) into a browser and run. This should successfully launch the Pairviewer. This step requires downloading some [https://d3js.org/ D3.js] resources, so if your internet connection is slow, this might take a while.
Now all that's left to do is try out Pairviewer yourself! Open your localhost address (can be copy-pasted from the terminal output of previous step) on a browser. And now you're all set!
 
   
 
== Using Pairviewer ==
 
== Using Pairviewer ==

Revision as of 13:13, 7 December 2018

The Apertium Pairviewer is a HTML5/D3.js tool that depicts all Apertium language pairs in an interactive graph initially developed sometime before the Google Code-In 2013. Its source code can be found on GitHub and an online demonstration is available here.

Setting up Pairviewer locally

Clone the git repository

Enter into the folder you want it to be in and download the whole program by running

git clone https://github.com/apertium/pairviewer.git

Set up a localhost with Python

You need to set up a localhost server before you can locally run Pairviewer.

First, check whether you have Python installed on your system and if so, what version(s) it is. Install preferably the latest one (Python 3) if it had not been done already.

python -v

Then make sure to enter the folder of the git repository you have cloned.

If you have is Python 3, run:

python3 -m http.server

Otherwise, if you do have Python 2, run:

python -m SimpleHTTPServer

You should see something like this on your terminal window.

Serving HTTP on 0.0.0.0 port 8000 (http://0.0.0.0:8000/) <---- copy-paste this URL!

Open on browser

Paste in your localhost address (e.g. http://0.0.0.0:80000/) into a browser and run. This should successfully launch the Pairviewer. This step requires downloading some D3.js resources, so if your internet connection is slow, this might take a while.

Using Pairviewer

How Pairviewer works

Known bugs

There are a few apparent bugs that should be fixed before the pair viewer goes public.

  • in initial view (sometimes?), quz has no line connecting it to spa
  • sometimes two- and three-letter codes don't seem to merge
    • when just trunk and staging are selected, tur/tr and nob/nb are each separate from one another
    • when trunk, staging, and nursery are selected, nob/nb are merged, but tur/tr are separate
  • when all possible pairs are viewed (including ones with missing stems, etc.), pa doesn't have a line connecting it to ur