Skip to main content

A RESTful interface to landlab graphs.

Project description

A RESTful interface to landlab graphs.

Quickstart

Use conda to install the necessary requirements and landlab_rest,

$ conda install --file=requirements.txt -c conda-forge
$ pip install .

Start the server,

$ start-sketchbook

Look at the line containing Serving on to see what host and port the server is running on. Alternatively, you can use the –host and –port options to specify a specific host and port (–help for help).

Now you should be able to send requests to the server. For instance, to get a RasterModelGrid,

$ curl https://0.0.0.0:8080/graphs/raster

For a list of supported graphs

$ curl https://0.0.0.0:8080/graphs/

You can pass parameters like,

$ curl 'https://0.0.0.0:8080/graphs/raster?shape=4,5&spacing=2.,1.'

Docker

To build a new docker image that will be a landlab-rest server,

docker build . -t landlab-rest

After building, run the server,

docker run -it -p 80:80 landlab-rest

Once running, you can then send requests to the server. For example,

$ curl https://0.0.0.0/graphs/raster

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

landlab_rest-0.2.0.tar.gz (20.2 kB view details)

Uploaded Source

File details

Details for the file landlab_rest-0.2.0.tar.gz.

File metadata

  • Download URL: landlab_rest-0.2.0.tar.gz
  • Upload date:
  • Size: 20.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for landlab_rest-0.2.0.tar.gz
Algorithm Hash digest
SHA256 c05c4884d62db8b4ec175e5e03b6f6fbb3ba03fa3ef3d7d42e7f4f4c07ba3859
MD5 0a43723007983b27e0779818a87f5213
BLAKE2b-256 a2ac7c9303e4ca97c050ada610e6c3a371701d40fe0bcdefc1fc352475df52ea

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page