pax_global_header 0000666 0000000 0000000 00000000064 13124726613 0014517 g ustar 00root root 0000000 0000000 52 comment=bdf8028358957be15bf7028e792ba7faa6c77641
gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/ 0000775 0000000 0000000 00000000000 13124726613 0021556 5 ustar 00root root 0000000 0000000 gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/ 0000775 0000000 0000000 00000000000 13124726613 0022506 5 ustar 00root root 0000000 0000000 gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/about.md 0000664 0000000 0000000 00000000002 13124726613 0024132 0 ustar 00root root 0000000 0000000
gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/about/ 0000775 0000000 0000000 00000000000 13124726613 0023620 5 ustar 00root root 0000000 0000000 gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/about/credits.md 0000664 0000000 0000000 00000000000 13124726613 0025565 0 ustar 00root root 0000000 0000000 gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/about/index.md 0000664 0000000 0000000 00000000063 13124726613 0025250 0 ustar 00root root 0000000 0000000 #Gargantext
Welcome to Garagentext documentation!
gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/about/license.md 0000664 0000000 0000000 00000000000 13124726613 0025552 0 ustar 00root root 0000000 0000000 gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/about/release-notes.md 0000664 0000000 0000000 00000000000 13124726613 0026676 0 ustar 00root root 0000000 0000000 gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/api_urls.md 0000664 0000000 0000000 00000006410 13124726613 0024647 0 ustar 00root root 0000000 0000000 List of garg's own JSON API(s) urls
===================================
2016-05-27
### /api/nodes/2
```
{
"id": 2,
"parent_id": 1,
"name": "abstract:\"evaporation+loss\"",
"typename": "CORPUS"
}
```
------------------------------
### /api/nodes?pagination_limit=-1
```
{
"records": [
{
"id": 9,
"parent_id": 2,
"name": "A recording evaporimeter",
"typename": "DOCUMENT"
},
(...)
{
"id": 119,
"parent_id": 81,
"name": "GRAPH EXPLORER COOC (in:81)",
"typename": "COOCCURRENCES"
}
],
"count": 119,
"parameters": {
"formated": "json","pagination_limit": -1,
"fields": ["id","parent_id","name","typename"],
"pagination_offset": 0
}
}
```
------------------------------
### /api/nodes?types[]=CORPUS
```
{
"records": [
{
"id": 2,
"parent_id": 1,
"name": "abstract:\"evaporation+loss\"",
"typename": "CORPUS"
},
(...)
{
"id": 8181,
"parent_id": 1,
"name": "abstract:(astrogeology+OR ((space OR spatial) AND planetary) AND geology)",
"typename": "CORPUS"
}
],
"count": 2,
"parameters": {
"pagination_limit": 10,
"types": ["CORPUS"],
"formated": "json",
"pagination_offset": 0,
"fields": ["id","parent_id","name","typename"]
}
}
```
------------------------------
### /api/nodes/5?fields[]=ngrams
Où <5> représente un doc_id ou list_id
```
{
"ngrams": [
[1.0,{"id":2299,"n":1,"terms":designs}],
[1.0,{"id":1917,"n":1,"terms":height}],
[1.0,{"id":1755,"n":2,"terms":higher speeds}],
[1.0,{"id":1940,"n":1,"terms":cylinders}],
[1.0,{"id":2221,"n":3,"terms":other synthesized materials}],
(...)
[2.0,{"id":1970,"n":1,"terms":storms}],
[9.0,{"id":1754,"n":2,"terms":spherical gauges}],
[1.0,{"id":1895,"n":1,"terms":direction}],
[1.0,{"id":2032,"n":1,"terms":testing}],
[1.0,{"id":1981,"n":2,"terms":"wind effects"}]
]
}
```
------------------------------
### api/nodes/3?fields[]=id&fields[]=hyperdata&fields[]=typename
```
{
"id": 3,
"typename": "DOCUMENT",
"hyperdata": {
"language_name": "English",
"language_iso3": "eng",
"language_iso2": "en",
"title": "A blabla analysis of laser treated aluminium blablabla",
"name": "A blabla analysis of laser treated aluminium blablabla",
"authors": "A K. Jain, V.N. Kulkarni, D.K. Sood"
"authorsRAW": [
{"name": "....", "affiliations": ["... Research Centre,.. 085, Country"]},
{"name": "....", "affiliations": ["... Research Centre,.. 086, Country"]}
(...)
],
"abstract": "Laser processing of materials, being a rapid melt quenching process, quite often produces a surface which is far from being ideally smooth for ion beam analysis. (...)",
"genre": ["research-article"],
"doi": "10.1016/0029-554X(81)90998-8",
"journal": "Nuclear Instruments and Methods In Physics Research",
"publication_year": "1981",
"publication_date": "1981-01-01 00:00:00",
"publication_month": "01",
"publication_day": "01",
"publication_hour": "00",
"publication_minute": "00",
"publication_second": "00",
"id": "61076EB1178A97939B1C893904C77FB7DA2276D0",
"source": "elsevier",
"distributor": "istex"
}
}
```
## TODO continuer la liste
gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/architecture.md 0000664 0000000 0000000 00000005742 13124726613 0025522 0 ustar 00root root 0000000 0000000
# Definitions and notation for the documentation (!= python notation)
## Node
The table (nodes) is a list of nodes: `[Node]`
Each Node has:
- a typename
- a parent_id
- a name
### Each Node has a parent_id
Node A
├── Node B
└── Node C
If Node A is Parent of Node B and Node C
then NodeA.id == NodeB.parent_id == NodeC.parent_id.
### Each Node has a typename
Notation: `Node["FOO"]("bar")` is a Node of typename "FOO" and with name "bar".
Then:
- Then Node[PROJECT] is a project.
- Then Node[CORPUS] is a corpus.
- Then Node[DOCUMENT] is a document.
The syntax of the Node here do not follow exactly Python documentation
(for clarity and to begin with): in Python code, typenames are strings
represented as UPPERCASE strings (eg. "PROJECT").
### Each Node as a typename and a parent
Node[USER](name)
├── Node[PROJECT](myProject1)
│ ├── Node[CORPUS](myCorpus1)
│ ├── Node[CORPUS](myCorpus2)
│ └── Node[CORPUS](myCorpus3)
└── Node[PROJECT](myProject2)
/!\\ 3 ways to manage rights of the Node:
1. Then Node[User] is a folder containing all User projects and corpus and
documents (i.e. Node[user] is the parent_id of the children).
2. Each node as a user_id (mainly used today)
3. Right management for the groups (implemented already but not
used since not connected to the frontend).
## Global Parameters
Global User is Gargantua (Node with typename user).
This node is the parent of the other nodes for parameters.
Node[USER](gargantua) (gargantua.id == Node[USER].user_id)
├── Node[TFIDF-Global](global) : without group
│ ├── Node[TFIDF](database1)
│ ├── Node[TFIDF](database2)
│ └── Node[TFIDF](database3)
└── Node[ANOTHERMETRIC](global)
[//]: # (Are there any plans to add user wide or project wide parameters or metrics? For example TFIDF nodes related to a normal user -- ie. not Gargantua?)
Yes we can in the future (but we have others priorities before.
[//]: # (What is the purpose of the 3 child nodes of Node[TFIDF-Global]? Are they TFIDF metrics related to databases 1, 2 and 3? If so, shouldn't they be children of related CORPUS nodes?)
Node placement in the tree indicates the context of the metric: the
Metrics Node has parent the corpus Node to indicate the context of the
metrics.
Answer:
Node[USER](foo)
Node[USER](bar)
├── Node[PROJECT](project1)
│ ├── Node[CORPUS](corpus1)
│ │ ├── Node[DOCUMENT](doc1)
│ │ ├── Node[DOCUMENT](doc2)
│ │ └── Node[TFIDF-global](name of the metrics)
│ ├── Node[CORPUS](corpus2)
│ └── Node[CORPUS](corpus3)
└── Node[PROJECT](project2)
## NodeNgram
NodeNgram is a relation of a Node with a ngram:
- documents and ngrams
- metrics and ngrams (position of the node metrics indicates the
context)
# Community Parameters
# User Parameters
gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/automatic_install.md 0000664 0000000 0000000 00000000002 13124726613 0026534 0 ustar 00root root 0000000 0000000 #
gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/contribute/ 0000775 0000000 0000000 00000000000 13124726613 0024664 5 ustar 00root root 0000000 0000000 gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/contribute/ngrams/ 0000775 0000000 0000000 00000000000 13124726613 0026153 5 ustar 00root root 0000000 0000000 ngram_parsing_flow.dot 0000775 0000000 0000000 00000001464 13124726613 0032472 0 ustar 00root root 0000000 0000000 gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/contribute/ngrams // dot ngram_parsing_flow.dot -Tpng -o ngram_parsing_flow.png
digraph ngramflow {
edge [fontsize=10] ;
label=<gargantext.util.toolchain
(ngram extraction flow)>;
labelloc="t" ;
"extracted_ngrams" -> "grouplist" ;
"extracted_ngrams" -> "occs+ti_rank" ;
"project stoplist (todo)" -> "stoplist" ;
"stoplist" -> "mainlist" ;
"occs+ti_rank" -> "mainlist" [label=" TI_RANK_LIMIT"];
"mainlist" -> "coocs" [label=" COOCS_THRESHOLD"] ;
"coocs" -> "specificity" ;
"specificity" -> "maplist" [label="MAPLIST_LIMIT\nMONOGRAM_PART"];
"mainlist" -> "tfidf" ;
"tfidf" -> "explore" [label="doc relations with all map and candidates"];
"maplist" -> "explore" ;
"grouplist" -> "occs+ti_rank" ;
"grouplist" -> "coocs" ;
"grouplist" -> "tfidf" ;
}
ngram_parsing_flow.png 0000664 0000000 0000000 00000227613 13124726613 0032473 0 ustar 00root root 0000000 0000000 gargantext-bdf8028358957be15bf7028e792ba7faa6c77641-docs/docs/contribute/ngrams PNG
IHDR S ۔ bKGD IDATxy\Te?ϰ,3 J
c&)cYOZWE+RGjiR*Oh"
3s,z^r9羯9ss$DD`1ƘA#`1N1Xc:892cuprd1cɑ1#c1V'GcN1XYӡ[}`ggk C"/lN-j<Sw0\*Jnݺooot9zh={ Gmҭ2334OC.ƚ頞0V\`r9fϞ
H$033-NQSnZ,ˆ#G%dggõk <Jk:ćNۚˠ)q<2~*{͛T*֯_Aaԩ>|8G 0ZגϣGOZYfj'11#G9 XdI$o1sLL0)))
6ԪƍEPPG=>z֮][:7mktSVc˖-9s0n8,^F"{1n8GUUUio ooz_cm˦ccu|@}*:w^^T\.'SSS@PO^fΜI#G$ bjѣ0]hh(mٲEx݅6oL hDD4i$%\NDD3gω襗^~ukPoZ''ze
թmƶm:ZM/"oH,z)*//o4
o ڼy3M<