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 #### Docker
  22   curl -sSL https://gitlab.iscpif.fr/gargantext/haskell-gargantext/raw/master/devops/docker-install | sh
  23
  24 #### Debian
  25   curl -sSL https://gitlab.iscpif.fr/gargantext/haskell-gargantext/raw/master/devops/debian-install | sh
  26
  27 ### Add dependencies
  28
  29 1. CoreNLP is needed (EN and FR); This dependency will not be needed
  30    soon.
  31   - wget https://dl.gargantext.org/coreNLP.tar.bz2
  32   - tar xvjf coreNLP.tar.bz2
  33   - ./startServer.sh
  34
  35 2. Louvain C++ needed to draw the socio-semantic graphs
  36   - git clone https://gitlab.iscpif.fr/gargantext/clustering-louvain-cplusplus.git
  37   - cd clustering-louvain-cplusplus
  38   - ./install
  39
  40 ### Initialization
  41
  42 Users has to be created first (user1 is created as instance):
  43
  44 - stack install
  45 - ~/.local/bin/gargantext-init "gargantext.ini"
  46
  47 ## Use Cases
  48
  49 ### Multi-User with Graphical User Interface (Server Mode)
  50
  51 ~/.local/bin/stack --docker exec gargantext-server -- --ini "gargantext.ini" --run Prod
  52 Then you can log in with user1:1resu
  53
  54
  55 ### Command Line Mode tools
  56
  57 #### Simple cooccurrences computation and indexation from a list of Ngrams
  58
  59 stack --docker exec gargantext-cli -- CorpusFromGarg.csv ListFromGarg.csv Ouput.json
  60