https://github.com/csiro-enviro-informatics/loci-integration-api

This application provides a convenient interface for executing common functions across the whole LOCI system.
https://github.com/csiro-enviro-informatics/loci-integration-api

api loci rest rest-api restful sanic sanic-restplus

Last synced: about 2 months ago
JSON representation

This application provides a convenient interface for executing common functions across the whole LOCI system.

• Host: GitHub
• URL: https://github.com/csiro-enviro-informatics/loci-integration-api
• Owner: CSIRO-enviro-informatics
• Created: 2019-09-18T13:10:50.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-08-25T00:07:27.000Z (over 3 years ago)
• Last Synced: 2024-03-18T15:32:12.645Z (10 months ago)
• Topics: api, loci, rest, rest-api, restful, sanic, sanic-restplus
• Language: Python
• Size: 200 KB
• Stars: 0
• Watchers: 7
• Forks: 3
• Open Issues: 12
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# LOCI Integration API

## Description

This application provides a convenient interface for executing common functions across the whole LOCI system.

## Implementation

Uses Sanic Asynchronous HTTP Service with the Sanic-Restplus plugin to generate API endpoint, and to auto-document the SwaggerUI.

## Run

docker-compose is included for an containerized local deployment

## Test/Develop

run `docker-compose -f docker-compose.yml -f docker-compose.dev.yml up --build` to build in dev model and run a container for running tests or development

if running the label search engine, run

`docker-compose -f docker-compose.yml -f docker-compose.dev.yml -f docker-compose.es.yml up --build` 

if running the label search engine only (no sanic api),

`docker-compose -f docker-compose.es.yml up --build` 

if running the api with docker image from docker hub

`docker-compose -f docker-compose.yml -f docker-compose.useimage.yml up -d` 

## Known issues

If running the elasticsearch appliance throws up an error like:

```

initial heap size [2685456] not equal to maximum heap size [2147483648]; this can cause resize pauses and prevents mlockall from locking the entire heap

```

Ensure this is updated on the OS like so...

```

$ sudo sysctl -w vm.max_map_count=262144

```

## License

The license of this document is TBD

## Contacts

Project Technical Lead:  

**Jonathan Yu**  

*Senior Experimental Scientist*  

CSIRO Land & Water

  

Lead Developer:  

**Ashley Sommer**  

*Software Engineer*  

CSIRO Land & Water

  

Developer:  

**Ben Leighton**  

*Software Engineer*  

CSIRO Land & Water