odgi server

Start a basic HTTP server with a given path index file to go from path:position to pangenome:position very efficiently.


odgi server [-i, --idx=FILE] [-p, --port=N] [OPTION]…


The odgi server command starts an HTTP server with a given path index as input. The idea is that we can go from path:positionpangenome:position via GET requests to the HTTP server. The server headers do not block cross origin requests. Example GET request: http://localost:3000/path_name/nucleotide_position.
The required path index can be created with odgi pathindex. Going from path:positionpangenome:position is important when navigating large graphs in an interactive manner like in the Pantograph project. All input and output positions are 1-based. If no IP address is specified, the server will run on localhost.



-i, --idx=FILE
Load the succinct variation graph index from this FILE. The file name usually ends with .xp.
-p, --port=N
Run the server under this port.

HTTP Options

-a, --ip=IP
Run the server under this IP address. If not specified, IP will be localhost.

Program Information

-h, --help
Print a help message for odgi server.