README.md

Photon and Neutron Search Api

Documentation

• Data Model
• API Calls
• Querying
• Units and Prefixes
• List of Roles
• List of Techniques

Prerequisites

• npm >= 6
• node >= 8

How to use the Photon and Neutron search api

1. Clone the repository

   git clone https://github.com/panosc-eu/search-api.git

2. Install node packages

   npm install

3. Start the server

   npm start

4. Optionally enable PaNET ontology fetching from an external URL (if this step is skipped no PaNET ontology is used)

   export PANET_BASE_URL=<the URL of the deployed pan-ontologies-api service>

   (pan-ontologies-api source code and container)

5. Try out the API using the example queries, either through http://localhost:3000/explorer or Curl.

   • Dataset Example Queries
   • Document Example Queries
   • Instrument Example Queries

Acceptance and integration tests

npm test