Metadata-Version: 1.1
Name: landlab_rest
Version: 0.2.0
Summary: A RESTful interface to landlab graphs.
Home-page: UNKNOWN
Author: Eric Hutton
Author-email: eric.hutton@colorado.edu
License: UNKNOWN
Description: ============
        landlab REST
        ============
        
        A RESTful interface to landlab graphs.
        
        
        ----------
        Quickstart
        ----------
        
        Use `conda` to install the necessary requirements and `landlab_rest`,
        
        .. code::
        
            $ conda install --file=requirements.txt -c conda-forge
            $ pip install .
        
        Start the server,
        
        .. code::
        
            $ 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`,
        
        .. code::
        
            $ curl https://0.0.0.0:8080/graphs/raster
        
        For a list of supported graphs
        
        .. code::
        
            $ curl https://0.0.0.0:8080/graphs/
        
        You can pass parameters like,
        
        .. code::
        
            $ 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,
        
        .. code::
        
            docker build . -t landlab-rest
        
        
        After building, run the server,
        
        .. code::
        
            docker run -it -p 80:80 landlab-rest
        
        Once running, you can then send requests to the server. For example,
        
        .. code::
        
            $ curl https://0.0.0.0/graphs/raster
        
Platform: UNKNOWN
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Cython
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Physics
