Deploying to gh-pages from @ e91c5ee 🚀

_modules/index.html

@@ -7,7 +7,7 @@
     <title>Overview: module code &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="../_static/alabaster.css?v=b21ac067" />
-    <script src="../_static/documentation_options.js?v=59fadc99"></script>
+    <script src="../_static/documentation_options.js?v=6e0256f3"></script>
     <script src="../_static/doctools.js?v=9a2dae69"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

_modules/pywdpa/get_token.html

@@ -7,7 +7,7 @@
     <title>pywdpa.get_token &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=b21ac067" />
-    <script src="../../_static/documentation_options.js?v=59fadc99"></script>
+    <script src="../../_static/documentation_options.js?v=6e0256f3"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

_modules/pywdpa/get_wdpa.html

@@ -7,7 +7,7 @@
     <title>pywdpa.get_wdpa &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="../../_static/alabaster.css?v=b21ac067" />
-    <script src="../../_static/documentation_options.js?v=59fadc99"></script>
+    <script src="../../_static/documentation_options.js?v=6e0256f3"></script>
     <script src="../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

_static/documentation_options.js

@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: '0.1.5',
+    VERSION: '0.1.6',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

changelog.html

@@ -8,7 +8,7 @@
     <title>Changelog &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=b21ac067" />
-    <script src="_static/documentation_options.js?v=59fadc99"></script>
+    <script src="_static/documentation_options.js?v=6e0256f3"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -61,6 +61,7 @@ <h3>Navigation</h3>
 <li class="toctree-l1"><a class="reference internal" href="reference.html">Python API</a></li>
 <li class="toctree-l1"><a class="reference internal" href="indices.html">Indices and tables</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="#pywdpa-0-1-6">pywdpa 0.1.6</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#pywdpa-0-1-5">pywdpa 0.1.5</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#pywdpa-0-1-4">pywdpa 0.1.4</a></li>
 <li class="toctree-l2"><a class="reference internal" href="#pywdpa-0-1-2-to-0-1-3">pywdpa 0.1.2 to 0.1.3</a></li>
@@ -108,6 +109,13 @@ <h3 id="searchlabel">Quick search</h3>
 
   <section id="changelog">
 <h1>Changelog<a class="headerlink" href="#changelog" title="Link to this heading">¶</a></h1>
+<section id="pywdpa-0-1-6">
+<h2>pywdpa 0.1.6<a class="headerlink" href="#pywdpa-0-1-6" title="Link to this heading">¶</a></h2>
+<ul class="simple">
+<li><p>Adding workflow for GitHub pages.</p></li>
+<li><p>Website update.</p></li>
+</ul>
+</section>
 <section id="pywdpa-0-1-5">
 <h2>pywdpa 0.1.5<a class="headerlink" href="#pywdpa-0-1-5" title="Link to this heading">¶</a></h2>
 <ul class="simple">
@@ -117,9 +125,9 @@ <h2>pywdpa 0.1.5<a class="headerlink" href="#pywdpa-0-1-5" title="Link to this h
 <section id="pywdpa-0-1-4">
 <h2>pywdpa 0.1.4<a class="headerlink" href="#pywdpa-0-1-4" title="Link to this heading">¶</a></h2>
 <ul class="simple">
-<li><p>Correcting a bug to include multipolygons</p></li>
-<li><p>Get started notebook</p></li>
-<li><p>Web-site update</p></li>
+<li><p>Correcting a bug to include multipolygons.</p></li>
+<li><p>Get started notebook.</p></li>
+<li><p>Website update.</p></li>
 </ul>
 </section>
 <section id="pywdpa-0-1-2-to-0-1-3">

code_of_conduct.html

@@ -8,7 +8,7 @@
     <title>Code of conduct &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=b21ac067" />
-    <script src="_static/documentation_options.js?v=59fadc99"></script>
+    <script src="_static/documentation_options.js?v=6e0256f3"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

contributing.html

@@ -8,7 +8,7 @@
     <title>Community guidelines &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=b21ac067" />
-    <script src="_static/documentation_options.js?v=59fadc99"></script>
+    <script src="_static/documentation_options.js?v=6e0256f3"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

genindex.html

@@ -7,7 +7,7 @@
     <title>Index &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=b21ac067" />
-    <script src="_static/documentation_options.js?v=59fadc99"></script>
+    <script src="_static/documentation_options.js?v=6e0256f3"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

index.html

@@ -8,7 +8,7 @@
     <title>pywdpa Python package &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=b21ac067" />
-    <script src="_static/documentation_options.js?v=59fadc99"></script>
+    <script src="_static/documentation_options.js?v=6e0256f3"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
@@ -132,6 +132,8 @@ <h2>Terms and conditions<a class="headerlink" href="#terms-and-conditions" title
 </section>
 <section id="prerequisites">
 <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this heading">¶</a></h2>
+<section id="access-to-protected-planet-api">
+<h3>Access to Protected Planet API<a class="headerlink" href="#access-to-protected-planet-api" title="Link to this heading">¶</a></h3>
 <p>This package uses the Protected Planet API to access data on world
 protected areas. You must first have obtained a Personal API Token by
 filling in the form available at
@@ -140,22 +142,53 @@ <h2>Prerequisites<a class="headerlink" href="#prerequisites" title="Link to this
 using either the command <code class="docutils literal notranslate"><span class="pre">os.environ[&quot;WDPA_KEY&quot;]=&quot;your_token&quot;</span></code> or
 <a class="reference external" href="https://github.com/theskumar/python-dotenv">python-dotenv</a>.</p>
 </section>
+<section id="gdal">
+<h3>GDAL<a class="headerlink" href="#gdal" title="Link to this heading">¶</a></h3>
+<p>GDAL must be installed on your system.</p>
+<p>To install GDAL on Windows, use the <a class="reference external" href="https://trac.osgeo.org/osgeo4w/">OSGeo4W</a> network installer. OSGeo4W is a binary distribution of a broad set of open source geospatial software for Windows environments (Windows 11 down to 7). Select <em>Express Install</em> and install GDAL. Several Gb of space will be needed on disk to install this programs. This will also install <em>OSGeo4W Shell</em> to execute command lines.</p>
+<p>To install GDAL on other systems, use your package manager, for example <code class="docutils literal notranslate"><span class="pre">apt</span></code> for Debian/Ubuntu Linux distributions.</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>sudo<span class="w"> </span>apt<span class="w"> </span>update
+sudo<span class="w"> </span>apt<span class="w"> </span>install<span class="w"> </span>gdal-bin<span class="w"> </span>libgdal-dev
+</pre></div>
+</div>
+<p>After installing GDAL, you can test the installation by running <code class="docutils literal notranslate"><span class="pre">gdalinfo</span> <span class="pre">--version</span></code> in the command prompt or terminal, which should display the installed GDAL version.</p>
+</section>
+</section>
 <section id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Link to this heading">¶</a></h2>
-<p>The easiest way to install the <code class="docutils literal notranslate"><span class="pre">pywdpa</span></code> Python package is via <a class="reference external" href="https://pip.pypa.io/en/stable/">pip</a>:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="c1"># For version on PyPI</span>
-$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>pywdpa
+<p>The easiest way to install the <code class="docutils literal notranslate"><span class="pre">pywdpa</span></code> Python package is via <a class="reference external" href="https://pip.pypa.io/en/stable/">pip</a> in the <em>OSGeo4W Shell</em> for Windows or in a virtual environment for Linux.</p>
+<p>For Linux, create and activate a virtual environment before install <code class="docutils literal notranslate"><span class="pre">pywdpa</span></code> with <code class="docutils literal notranslate"><span class="pre">pip</span></code>:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="nb">cd</span><span class="w"> </span>~
+<span class="c1"># Create a directory for virtual environments</span>
+mkdir<span class="w"> </span>venvs
+<span class="c1"># Create the virtual environment with venv</span>
+python3<span class="w"> </span>-m<span class="w"> </span>venv<span class="w"> </span>~/venvs/venv-pywdpa
+<span class="c1"># Activate (start) the virtual environment</span>
+<span class="nb">source</span><span class="w"> </span>~/venvs/venv-pywdpa/bin/activate
+</pre></div>
+</div>
+<p>Install Python dependencies and <code class="docutils literal notranslate"><span class="pre">pywdpa</span></code> in the <em>OSGeo4W Shell</em> or in the newly created virtual environment:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># Upgrade pip, setuptools, and wheel</span>
+python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>--upgrade<span class="w"> </span>pip<span class="w"> </span>setuptools<span class="w"> </span>wheel
+<span class="c1"># Install numpy</span>
+python3<span class="w"> </span>-m<span class="w"> </span>numpy
+<span class="c1"># Install gdal Python bindings (the correct version)</span>
+python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span><span class="nv">gdal</span><span class="o">==</span><span class="k">$(</span>gdal-config<span class="w"> </span>--version<span class="k">)</span>
+<span class="c1"># Install pywdpa. This will install all other dependencies</span>
+python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>pywdpa
+</pre></div>
+</div>
+<p>If you want to install the development version of <code class="docutils literal notranslate"><span class="pre">pywdpa</span></code>, replace the last line with:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>https://github.com/ghislainv/pywdpa/archive/master.zip
 </pre></div>
 </div>
-<p>or</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span><span class="c1"># For development version on GitHub</span>
-$<span class="w"> </span>python<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w"> </span>https://github.com/ghislainv/pywdpa/archive/master.zip
+<p>To deactivate and delete the virtual environment:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>deactivate
+rm<span class="w"> </span>-R<span class="w"> </span>~/venvs/venv-pywdpa<span class="w"> </span><span class="c1"># Just remove the repository</span>
 </pre></div>
 </div>
-<p>but you can also install <code class="docutils literal notranslate"><span class="pre">pywdpa</span></code> executing the <code class="docutils literal notranslate"><span class="pre">setup.py</span></code> file:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$<span class="w"> </span>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/ghislainv/pywdpa
-$<span class="w"> </span><span class="nb">cd</span><span class="w"> </span>pywdpa
-$<span class="w"> </span>python<span class="w"> </span>setup.py<span class="w"> </span>install
+<p>In case of problem while installing GDAL Python bindings, try the following command:</p>
+<div class="highlight-shell notranslate"><div class="highlight"><pre><span></span>python3<span class="w"> </span>-m<span class="w"> </span>pip<span class="w"> </span>install<span class="w">  </span>--no-cache-dir<span class="w"> </span>--force-reinstall<span class="w"> </span><span class="nv">gdal</span><span class="o">==</span><span class="k">$(</span>gdal-config<span class="w"> </span>--version<span class="k">)</span>
 </pre></div>
 </div>
 </section>
@@ -187,6 +220,7 @@ <h2>Table of contents<a class="headerlink" href="#table-of-contents" title="Link
 </li>
 <li class="toctree-l1"><a class="reference internal" href="indices.html">Indices and tables</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="changelog.html#pywdpa-0-1-6">pywdpa 0.1.6</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#pywdpa-0-1-5">pywdpa 0.1.5</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#pywdpa-0-1-4">pywdpa 0.1.4</a></li>
 <li class="toctree-l2"><a class="reference internal" href="changelog.html#pywdpa-0-1-2-to-0-1-3">pywdpa 0.1.2 to 0.1.3</a></li>

indices.html

@@ -8,7 +8,7 @@
     <title>Indices and tables &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=b21ac067" />
-    <script src="_static/documentation_options.js?v=59fadc99"></script>
+    <script src="_static/documentation_options.js?v=6e0256f3"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>

license.html

@@ -8,7 +8,7 @@
     <title>License &#8212; pywdpa — A simple access to world&#39;s protected areas</title>
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=d1102ebc" />
     <link rel="stylesheet" type="text/css" href="_static/alabaster.css?v=b21ac067" />
-    <script src="_static/documentation_options.js?v=59fadc99"></script>
+    <script src="_static/documentation_options.js?v=6e0256f3"></script>
     <script src="_static/doctools.js?v=9a2dae69"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>