Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix: use pure rst in the readme file #51

Merged
merged 2 commits into from
Jan 9, 2024
Merged

fix: use pure rst in the readme file #51

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9c50532
fix: only use pure rst in the readme
12rambau Jan 9, 2024
66cba44
docs: make the notes a section
12rambau Jan 9, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions README.rst
View file
Open in desktop
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