Metadata-Version: 2.1
Name: s2cell
Version: 1.0.0
Summary: Minimal Python S2 cell ID, S2 token and lat/lon conversion library
Home-page: https://github.com/aaliddell/s2cell
Author: Adam Liddell
Author-email: s2cell@aliddell.com
License: UNKNOWN
Description: s2cell
        ======
        
        Minimal Python `S2 <https://s2geometry.io/>`_
        `cell ID <https://s2geometry.io/devguide/s2cell_hierarchy.html>`_, S2 token and lat/lon conversion
        library.
        
        .. image:: https://github.com/aaliddell/s2cell/workflows/CI/badge.svg
           :alt: CI Status
           :target: https://github.com/aaliddell/s2cell/actions
        
        .. image:: https://img.shields.io/github/license/aaliddell/s2cell
           :alt: License
           :target: https://github.com/aaliddell/s2cell
        
        .. image:: https://img.shields.io/pypi/v/s2cell
           :alt: PyPI Version
           :target: https://pypi.org/project/s2cell/
        
        
        Overview
        --------
        
        This library only does conversion between S2 cell ID/token, S2Point and latitude/longitude and was
        written as a method to understand the way the S2 cell system works; hopefully this is useful as a
        single-file reference on the process. All steps in the conversion are well commented and written to
        be understandable rather than necessarily fast.
        
        The library is checked against a test suite generated from the
        `reference C++ implementation <https://github.com/google/s2geometry>`_ to ensure conformity with the
        standard.
        
        Should you need more complete S2 functionality or a fast C-based implementation, please consider
        using the `Python extension included <https://github.com/google/s2geometry/tree/master/src/python>`_
        in the s2geometry repository or the pure-Python `s2sphere <https://pypi.org/project/s2sphere/>`_
        implementation.
        
        Issues and PRs are very welcome to improve the descriptions or correct any misunderstandings of the
        S2 cell system. Please note that this library strives to be an easy to read reference rather than
        aiming for peak performance (it is in Python after all), so PRs which reduce readability of the
        implementation (such as for Python specific speed optimisations) are generally discouraged. However,
        if you have optimisations that are applicable to S2 implementations across many langauges and can be
        described easily, please do consider making a PR.
        
        
        Installation
        ------------
        
        This package can be installed from `PyPI <https://pypi.org/project/s2cell/>`_ with pip or any
        other Python package manager:
        
        .. code-block:: bash
        
           pip install s2cell
        
        
        Usage
        -----
        
        Conversion from lat/lon (in degrees) to a cell ID or token can be done with the following two
        functions:
        
        .. code-block:: python3
        
           s2cell.lat_lon_to_cell_id(-10.490091, 105.641318)  # -> 3383782026967071427
           s2cell.lat_lon_to_token(-10.490091, 105.641318)    # -> '2ef59bd352b93ac3'
        
        By default, these conversions will give you a level 30 leaf-cell as output. If you require a lower
        precision level, you can specify this:
        
        .. code-block:: python3
        
           s2cell.lat_lon_to_cell_id(-10.490091, 105.641318, 10)  # -> 3383781119341101056
           s2cell.lat_lon_to_token(-10.490091, 105.641318, 0)     # -> '3'
        
        Conversion from a cell ID or token to lat/lon (in degrees) can be done with the following two
        functions:
        
        .. code-block:: python3
        
           s2cell.cell_id_to_lat_lon(3383781119341101056)  # -> (-10.452552407574101, 105.6412526632361)
           s2cell.token_to_lat_lon('3')                    # -> (0.0, 90.0)
        
        The lat/lon returned will be the centre of the cell at the level available in the provided cell ID
        or token.
        
        
        Useful S2 Links
        ---------------
        
        - `S2 Geometry <https://s2geometry.io/>`_: The S2 Geometry homepage.
        - `S2 Cells <https://s2geometry.io/devguide/s2cell_hierarchy>`_: Reference S2 documentation on the
          S2 cell system.
        - `Earth Cube <https://s2geometry.io/resources/earthcube>`_: Description of the face cell mapping
          in the S2 cell system.
        - `S2 Cell Statistics <https://s2geometry.io/resources/s2cell_statistics>`_: Details on the sizes of
          S2 cells at each level.
        - `google/s2geometry <https://github.com/google/s2geometry>`_: The reference C++ and Python
          implementation.
        - `google/s2-geometry-library-java <https://github.com/google/s2-geometry-library-java>`_: The
          reference Java implementation.
        - `sidewalklabs/s2sphere <https://github.com/sidewalklabs/s2sphere>`_: A pure-Python S2
          implementation.
        
        If you have another S2 related link that may be useful here, please open an Issue or PR.
        
        
        License
        -------
        
        This project is released under the same license as the reference C++ S2 Geometry implementation,
        namely the Apache 2.0 License.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Telecommunications Industry
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Scientific/Engineering :: GIS
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
Provides-Extra: dev
