README.md

ARC-Finder – A simple, locally-deployed tool to find your peer's research data

This is a tool to help you find metadata about ARCs stored in the DataPLANT DataHUB. Visit the DataPLANT website for more information about ARCs (annotated research contexts).

Usage

• Git clone or download this repository.
• Open a command line or terminal and navigate to the arcFinder directory.
• Run one of the following two options:

Option 1: Search public ARCs only

./arcFinder.sh

Option 2: Search Public + privately shared ARCs

Note: Replace <gitlab pat> with the path pointing to a file which stores a GitLab personal access token (PAT).

./arcFinder.sh -p <gitlab pat>

Registration with DataPLANT

In order to use the <gitlab pat> option, please follow these steps:

1. Sign up with DataPLANT.
2. Generate a personal access token in the DataHUB PAT settings
   • Provide a "Token name", e.g. arcFinder
   • Select either option "api" or "read_api" and click "Create personal access token"
   • Copy the generated token on top of the page.
3. Paste the bare token into a text file and save it (e.g. gitlab_token stored in the root of this directory)
4. Supply the file path to arcFinder, e.g.:

./arcFinder.sh -p gitlab_token

Documentation

• Read the full project outline or view the slides for context and more details.
• Check out the gif to see the ARC-Finder in action

License

This work is licensed under a Creative Commons Attribution 4.0 International License.