README.md

   1 # Gargantext Haskell
   2
   3 ## About this project
   4
   5 Gargantext is a collaborative web platform for the exploration of sets
   6 of unstructured documents. It combines tools from natural language
   7 processing, text-mining, complex networks analysis and interactive data
   8 visualization to pave the way toward new kinds of interactions with your
   9 digital corpora.
  10
  11 This software is a free software, developed by the CNRS Complex Systems
  12 Institute of Paris Île-de-France (ISC-PIF) and its partners.
  13
  14 ## Installation
  15
  16 Disclaimer: this project is still on development, this is work in
  17 progress. Please report and improve this documentation if you encounter
  18 issues.
  19
  20 ### Build Core Code
  21
  22 #### Docker
  23
  24 ``` sh
  25 curl -sSL https://gitlab.iscpif.fr/gargantext/haskell-gargantext/raw/master/devops/docker/docker-install | sh
  26 ```
  27
  28 #### Debian
  29
  30 ``` sh
  31 curl -sSL https://gitlab.iscpif.fr/gargantext/haskell-gargantext/raw/master/devops/debian/install | sh
  32 ```
  33
  34 ### Add dependencies
  35
  36 1. CoreNLP is needed (EN and FR); This dependency will not be needed
  37    soon.
  38
  39 ``` sh
  40 ./devops/install-corenlp
  41 ```
  42
  43 2. Louvain C++ needed to draw the socio-semantic graphs
  44
  45 NOTE: This is already added in the Docker build.
  46
  47 ``` sh
  48 git clone https://gitlab.iscpif.fr/gargantext/clustering-louvain-cplusplus.git
  49 cd clustering-louvain-cplusplus
  50 ./install
  51 ```
  52
  53 ### Initialization
  54
  55 #### Docker
  56
  57 Run PostgreSQL first:
  58
  59 ``` sh
  60 cd devops/docker
  61 docker-compose up
  62 ```
  63
  64 Initialization schema should be loaded automatically (from `devops/postgres/schema.sql`).
  65
  66 #### Gargantext
  67
  68 ##### Fix the passwords
  69
  70 Change the passwords in gargantext.ini_toModify then move it:
  71
  72 mv gargantext.ini_toModify gargantext.ini
  73
  74 (.gitignore avoids adding this file to the repository by mistake)
  75
  76
  77 ##### Run Gargantext
  78
  79 Users have to be created first (`user1` is created as instance):
  80
  81 ``` sh
  82 stack install
  83 ~/.local/bin/gargantext-init "gargantext.ini"
  84 ```
  85
  86 For Docker env, first create the appropriate image:
  87
  88 ``` sh
  89 cd devops/docker
  90 docker build -t fpco/stack-build:lts-14.27-garg .
  91 ```
  92
  93 then run:
  94
  95 ``` sh
  96 stack --docker run gargantext-init -- gargantext.ini
  97 ```
  98
  99 ### Importing data
 100
 101 You can import some data with:
 102 ``` sh
 103 docker run --rm -it -p 9000:9000 cgenie/corenlp-garg
 104 stack exec gargantext-import -- "corpusCsvHal" "user1" "IMT3" gargantext.ini 10000 ./1000.csv
 105 ```
 106
 107 ## Use Cases
 108
 109 ### Multi-User with Graphical User Interface (Server Mode)
 110
 111 ``` sh
 112 ~/.local/bin/stack --docker exec gargantext-server -- --ini "gargantext.ini" --run Prod
 113 ```
 114
 115 Then you can log in with `user1:1resu`.
 116
 117
 118 ### Command Line Mode tools
 119
 120 #### Simple cooccurrences computation and indexation from a list of Ngrams
 121
 122 stack --docker exec gargantext-cli -- CorpusFromGarg.csv ListFromGarg.csv Ouput.json
 123