arrow-left

All pages
gitbookPowered by GitBook
1 of 13

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Can I use Datashare with no internet connection?

You need an internet connection to install Datashare.

You also need the internet to find people, organizations and locations in documents the first time you use any new NLP option because the models which find these named entities are downloaded when you ask for finding named entities the first time. Subsequently, you don't need an internet connection to find named entities after.

You don't need internet connection to:

  • Add documents to Datashare

  • Find named entities (except for the first time you use an NLP options - see above)

  • Search and explore documents

  • Download documents

This allows you to work safely on your documents. No third-party should be able to intercept your data and files while you're working offline on your computer.

Advanced: how can I do bulk actions with Tarentula?

Tarentula is a tool made for advanced users to run bulk actions in Datashare, like:

  • Clean Tags by Queryarrow-up-right

  • Downloadarrow-up-right

Please find all the use cases in Datashare Tarentula's .

Export by Queryarrow-up-right
Taggingarrow-up-right
CSV formatsarrow-up-right
Tagging by Queryarrow-up-right
GitHub documentationarrow-up-right

Can I download a document from Datashare?

Yes, you can download a document from Datashare.

hashtag
Download a document

Open the menu > 'Search' > 'Documents' and click on the download icon on the right of documents' cards:

...or on the top right of an opened document:

hashtag
Batch download documents

You can also batch download all the documents that match a search. It is limited to 100.00MB.

Open the menu > 'Search' > 'Documents', make queries and apply filter. Once all the results of a specific search are relevant to you, click on the download icon on the right of results:

Find your batch downloads as zip files in the menu > 'Tasks' > 'Batch downloads':

Click on a batch download's name to download it:

hashtag
Can't download?

If you can't download a document, it means that:

  • either Datashare has been badly initialized. Please restart Datashare. If you're an advanced user, you can capture the logs and create an issue on .

  • or you are using the server collaborative mode and the admins prevented users from downloading documents

Datashare's Githubarrow-up-right
Screenshot of Datashare's search page in List view with the download icons in 3 document cards highlighted
Screenshot of Datashare's search page in List view with a document open and the download icons on the top right of the document highlighted
Screenshot of Datashare's search page in List view with the download icon on the top right of the result column highlighted
Screenshot of Datashare's batch downloads page with the menu open and the Tasks' entry 'Batch downloads' highlighted
Screenshot of Datashare's batch downloads page with the name of one batch download highlighted

Can I remove document(s) from Datashare?

In local mode, you cannot remove a single document or a selection of documents from Datashare. But you can remove all your projects and documents from Datashare.

Open the menu and on the bottom of the menu, click the trash icon:

A confirmation window opens. The action cannot be undone. It removes all the projects and their documents from Datashare. Click 'Yes' if you are sure:

For advanced users - if you'd like to do it with the Terminal, here are the instructions:

  • If you're using Mac: rm -Rf ~/Library/Datashare/index

  • If you're using Windows: rd /s /q "%APPDATA%"\Datashare\index

  • If you're using Linux: rm -Rf ~/.local/share/datashare/index

Screenshot of Datashare's homepage with the menu and the trash icon at the bottom right of the menu highlighted
Screenshot of Datashare's homepage with a confirmation modal to delete all projects and documents highlighted

General

👷‍♀️ This page is currently being written by Datashare team.

Can I use an external drive as data source?

Warning: this requires some technological knowledge.

You can make Datashare follow soft links : add --followSymlinks when Datashare is launched.

If you're on Mac or Windows, you must change the launch script.

If you're on Linux, you can add the option after the Datashare command.

Do you recommend OS or machines for large corpuses?

Datashare was created with scalability in mind which gave ICIJ the ability to index terabytes of documents.

To do so, we used a cluster of dozens of EC2 instances on AWS, running on Ubuntu 16.04 and 18.04. We used c4.8xlarge instances (36 CPUs / 60 GB RAM).

The most complex operation is OCR (we use Apache Tesseractarrow-up-right) so if your documents don't contain many images, it might be worth deactivating it (--ocr false).

How can I contact ICIJ for help, bug reporting or suggestions?

You can send an email to datashare@icij.org.

When reporting a bug, please share:

  • Your OS (Mac, Windows or Linux) and version

  • The problem, with screenshots

  • The actions that led to the problem

Or you can post an issue with your logs on Datashare's GitHub:

https://github.com/ICIJ/datashare/issuesarrow-up-right

How can we use Datashare on a collaborative mode on a server?

You can use Datashare with multiple users accessing a centralized database on a server.

Warning: to put the server mode in place and to maintain it requires some technical knowledge.

Please find the documentation here.

What should I do if I get more than 10,000 results?

In Datashare, for technical reasons, it is not possible to open the 10,000th document.

Example: you search for "Paris", you get 15,634 results. You'd be able to see the first 9,999th results but no more. This also happens if you didn't run any search.

As it is not possible to fix this, here are some tips:

  • Refine your search: use filters to narrow down your results and ensure you have less than 10,000 matching documents

  • Change the sorting of your results: use 'creation date' or 'alphabetical order' for instance, instead of the sorting by default which corresponds to a relevance scoring

  • Search your query in a : you will get all your results either on the batch search results' page or, by downloading your results, in a spreadsheet. From there, you will be able to open and read all your documents

batch search

Why results from a simple search and a batch search can be slightly different?

If you search "Shakespeare" in the search bar and if you run a query containing "Shakespeare" in a batch search, you can get slightly different documents between the two results.

Why?

For technical reasons, Datashare processes both queries in 2 different ways:

a. Search bar (a simple search processed in the browser):

The search query sent to Elasticsearch is processed in your browser by Datashare's client. It is then sent to Elasticsearch through Datashare server which forwards your query.

b. Batch search (several searches processed by the server):

  1. Datashare's server processes each of the batch search's queries

  2. Each query is sent to Elasticsearch. The results are saved into a database

  3. When the batch search is finished, you get the results from Datashare

Datashare's team attempts to make both results be similar, but slight differences can happen between the two queries.

Datashare sends back the results stored into the database/
A diagram with the title 'Query from navigator'

How to run Neo4j?

This page explains how to run a neo4j instance inside docker. For any additional information please refer to the [neo4j documentation](https://neo4j.com/docs/getting-started/)

hashtag
Run Neo4j inside docker

1. enrich the services section of the docker-compose.yml of the install with Docker page, with the following neo4j service:

make sure not to forget the APOC pluginarrow-up-right (NEO4J_PLUGINS: '["apoc"]').

2. enrich the volumes section of the docker-compose.yml of the page, with the following neo4j volumes:

3. Start the neo4j service using:

hashtag
Run Neo4j Desktop

  1. install with , follow installation instructions found

  2. and save your password for later

  3. if the installer notifies you of any ports modification, check the and save the server.bolt.listen_address for later

hashtag
Additional options

Additional options to install neo4j are .

...
services:
    neo4j:
      image: neo4j:5-community
      environment:
        NEO4J_AUTH: none
        NEO4J_PLUGINS: '["apoc"]'
      ports:
        - 7474:7474
        - 7687:7687
      volumes:
        - neo4j_conf:/var/lib/neo4j/conf
        - neo4j_data:/var/lib/neo4j/data

make sure to install the APOC Pluginarrow-up-right

install with Docker
Neo4j Desktoparrow-up-right
herearrow-up-right
create a new local DBMSarrow-up-right
DBMS settingsarrow-up-right
listed herearrow-up-right
volumes:
  ...
  neo4j_data:
    driver: local
  neo4j_conf:
    driver: local
docker compose up -d neo4j

How can I uninstall Datashare?

hashtag
Mac

1. Go to Applications

2. Click right on 'Datashare' and click 'Move to Bin'

hashtag
Windows

Follow the steps here:

hashtag
Linux

Use the following command:

sudo apt remove datashare-dist

https://support.microsoft.com/en-us/windows/uninstall-or-remove-apps-and-programs-in-windows-10-4b55f974-2cc6-2d2b-d092-5905080eaf98arrow-up-right
Screenshot of a Mac's 'Applications' window with the Datashare's logo highlighted
Screenshot of a Mac's Applications window with the Datashare's logo selected and a dropdown menu with the entry 'Move to Bin' highlighted