Skip to content

Commit

Permalink
fix: use pure rst in the readme file (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
12rambau committed Jan 9, 2024
2 parents ab2e72b + 66cba44 commit 12310d2
Show file tree
Hide file tree
Showing 3 changed files with 5,426 additions and 12 deletions.
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,5 @@
.. raw:: html

<p align="center">
<img src="docs/_static/logo.png" width=240 alt="header"></a>
</p>

<h1 align="center">pyGAUL</h1>
pyGAUL
======

.. image:: https://img.shields.io/badge/License-MIT-yellow.svg?logo=opensourceinitiative&logoColor=white
:target: LICENSE
Expand Down Expand Up @@ -49,14 +44,14 @@
Overview
--------

.. image:: docs/_static/logo.svg
:width: 20%
:align: right

Easy access to administrative boundary defined by FAO GAUL 2015 from Python scripts.

This lib provides access to FAO GAUL 2015 datasets from a Python script. it is the best boundary dataset available for GEE at this point. We provide access to The current version (2015) administrative areas till level 2.

.. note::

the dataset was generated in 2015 by the Food and Alimentation Organization (FAO). It has not been updated on Google Earthengine since then. Use with caution on disputed territories.

install it using either ``pip`` or ``conda``:

.. code-block:: console
Expand All @@ -71,6 +66,11 @@ and then request area of interest from their name or GADM Id:
gdf = pygaul.Items(name="Singapore", content_level=1)
Note
----

the dataset was generated in 2015 by the Food and Alimentation Organization (FAO). It has not been updated on Google Earthengine since then. Use with caution on disputed territories.

Credits
-------

Expand Down
Loading

0 comments on commit 12310d2

Please sign in to comment.