![](\"images/tf.png\")
\n",
"![](\"images/uu-small.png\")
\n",
"![](\"images/dans.png\")
\n",
"\n",
"# Tutorial\n",
"\n",
"This notebook gets you started with using\n",
"[Text-Fabric](https://annotation.github.io/text-fabric/) for coding in the Quran.\n",
"\n",
"Familiarity with the underlying\n",
"[data model](https://annotation.github.io/text-fabric/tf/about/datamodel.html)\n",
"is recommended."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Installing Text-Fabric\n",
"\n",
"### Python\n",
"\n",
"You need to have Python on your system. Most systems have it out of the box,\n",
"but alas, that is python2 and we need at least python **3.6**.\n",
"\n",
"Install it from [python.org](https://www.python.org) or from\n",
"[Anaconda](https://www.anaconda.com/download).\n",
"\n",
"### TF itself\n",
"\n",
"```\n",
"pip3 install text-fabric\n",
"```\n",
"\n",
"### Jupyter notebook\n",
"\n",
"You need [Jupyter](http://jupyter.org).\n",
"\n",
"If it is not already installed:\n",
"\n",
"```\n",
"pip3 install jupyter\n",
"```"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Tip\n",
"If you start computing with this tutorial, first copy its parent directory to somewhere else,\n",
"outside your `syrnt` directory.\n",
"If you pull changes from the `syrnt` repository later, your work will not be overwritten.\n",
"Where you put your tutorial directory is up till you.\n",
"It will work from any directory."
]
},
{
"cell_type": "code",
"execution_count": 1,
"metadata": {
"ExecuteTime": {
"end_time": "2018-10-18T10:40:34.922214Z",
"start_time": "2018-10-18T10:40:34.901689Z"
}
},
"outputs": [],
"source": [
"%load_ext autoreload\n",
"%autoreload 2"
]
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {
"ExecuteTime": {
"end_time": "2018-10-18T10:40:36.468086Z",
"start_time": "2018-10-18T10:40:36.442023Z"
}
},
"outputs": [],
"source": [
"import os\n",
"import collections"
]
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {
"ExecuteTime": {
"end_time": "2018-10-18T10:40:37.964346Z",
"start_time": "2018-10-18T10:40:37.346091Z"
}
},
"outputs": [],
"source": [
"from tf.app import use"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Quran data\n",
"\n",
"Text-Fabric will fetch a standard set of features for you from the newest GitHub release binaries.\n",
"\n",
"The data will be stored in the `text-fabric-data` in your home directory."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Load Features\n",
"The data of the corpus is organized in features.\n",
"They are *columns* of data.\n",
"Think of the text as a gigantic spreadsheet, where row 1 corresponds to the\n",
"first word, row 2 to the second word, and so on, for all 100,000+ words.\n",
"\n",
"The letters of each word is a column `form` in that spreadsheet.\n",
"\n",
"The corpus contains ca. 30 columns, not only for the words, but also for\n",
"textual objects, such as *suras*, *ayas*, and *word groups*.\n",
"\n",
"Instead of putting that information in one big table, the data is organized in separate columns.\n",
"We call those columns **features**."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"For the very last version, use `hot`.\n",
"\n",
"For the latest release, use `latest`.\n",
"\n",
"If you have cloned the repos (TF app and data), use `clone`.\n",
"\n",
"If you do not want/need to upgrade, leave out the checkout specifiers."
]
},
{
"cell_type": "code",
"execution_count": 5,
"metadata": {
"ExecuteTime": {
"end_time": "2018-10-18T10:40:42.958397Z",
"start_time": "2018-10-18T10:40:41.535490Z"
}
},
"outputs": [
{
"data": {
"text/html": [
"TF-app: ~/text-fabric-data/q-ran/quran/app"
],
"text/plain": [
"