Metadata-Version: 1.1
Name: cx
Version: 0.2.0
Summary: Compute nearest neighbor distances along the coast with a view angle.
Home-page: https://github.com/bast/coastal-express
Author: Radovan Bast
Author-email: radovan.bast@uit.no
License: MPL-2.0
Description-Content-Type: UNKNOWN
Description: .. image:: https://travis-ci.org/bast/coastal-express.svg?branch=master
           :target: https://travis-ci.org/bast/coastal-express/builds
        .. image:: https://img.shields.io/badge/license-%20MPL--v2.0-blue.svg
           :target: ../master/LICENSE
        
        
        Coastal express
        ===============
        
        Compute nearest neighbor distances along the coast with a view angle.
        
        
        Installation
        ------------
        
        .. code:: shell
        
          $ pip install cx
        
        
        Example
        -------
        
        .. code:: shell
        
          cx --boundary="$PWD/boundary.txt" \
             --islands="$PWD/islands.txt" \
             --view-angle=20.0 \
             --min-distance=3.0 \
             --max-distance=40.0 \
             --output-dir="$PWD/output"
        
        
        Available options
        -----------------
        
        .. code:: shell
        
          $ cx --help
        
          Usage: cx [OPTIONS]
        
          Options:
            --boundary TEXT      File containing the boundary.
            --islands TEXT       File(s) containing island data - you can use wildcards.
            --view-angle TEXT    View angle in degrees.
            --min-distance TEXT  Min distance.
            --max-distance TEXT  Max distance.
            --output-dir TEXT    Direction of the time arrow (0, 90, 180, or 270).
            --help               Show this message and exit.
        
        
        Definition of the view angle
        ----------------------------
        
        The code will form view vectors perpendicular to the coastline. The code will
        make sure that along the boundary, the vectors point towards "inside" and along
        islands they point towards "outside". The view vector is computed to be
        perpendicular to the vector connecting the two neighboring points of the
        current point.
        
        The view angle of N degrees defines a view sector N/2 degrees to both sides of
        the view vector.  In other words a view angle of N degrees is N degrees wide in
        total and is oriented symmetrically around the view vector which is
        perpendicular to the coast line.
        two neighboring points.
        
        
        Input and output formats
        ------------------------
        
        The code will read boundary and island files. It assumes that the first line in
        the boundary file contains the total number of polygon points, followed by one
        line per point.  First and last polygon point are expected to be the same
        point.  Two first numbers in each line are assumed to be x and y coordinates in
        arbitrary but consistent units.  Each line can contain more numbers and the
        code will not worry about these.
        
        The code can read one or many island files. Each island file can contain one or
        many polygons.  Each polygon starts with one line specifying the total number
        of points.  First and last polygon point are expected to be the same point.
        Each point line is interpreted the same way as the boundary.
        
        The output format preserves all lines and numbers and the only thing it will do
        is to append each point line by the computed distance. In other words each
        point line will become longer by one number.
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
