delete old files, update docs, version 1.0

FireHR/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.4"
+__version__ = "0.1.0"

README.md

@@ -2,13 +2,29 @@
 
 
 
-## Install
+## Install using pip
 
 `pip install FireHR`
 
+## Install from repo
+```bash
+git clone https://github.com/mnpinto/FireHR
+cd FireHR; pip install -e .
+```
+
 ## How to use
 
-### Command line utility to run FireHR for an event as outputed by BA-Net post-processing
+#### Configuration of Google Earth Engine API
+Run the following python code and follow the link to generate the authentication file:
+```python
+import ee
+ee.Authenticate()
+```
+Once you are done you should see the message `Successfully saved authorization token.` and the file `~/.config/earthengine/credentials` should exist. 
+
+Please refer to https://developers.google.com/earth-engine/guides/python_install for more information about the GEE Python API. 
+
+#### Command line utility to run FireHR for an event as outputed by BA-Net post-processing
 ```bash
 firehr_from_banet_events ba100m_PT2020_218.tif
 ```

docs/index.html

@@ -31,14 +31,23 @@
 
 <div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html">
-<h2 id="Install">Install<a class="anchor-link" href="#Install"> </a></h2>
+<h2 id="Install-using-pip">Install using pip<a class="anchor-link" href="#Install-using-pip"> </a></h2>
 </div>
 </div>
 </div>
 <div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html">
 <p><code>pip install FireHR</code></p>
 
+</div>
+</div>
+</div>
+<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
+<div class="text_cell_render border-box-sizing rendered_html">
+<h2 id="Install-from-repo">Install from repo<a class="anchor-link" href="#Install-from-repo"> </a></h2><div class="highlight"><pre><span></span>git clone https://github.com/mnpinto/FireHR
+<span class="nb">cd</span> FireHR<span class="p">;</span> pip install -e .
+</pre></div>
+
 </div>
 </div>
 </div>
@@ -50,7 +59,19 @@ <h2 id="How-to-use">How to use<a class="anchor-link" href="#How-to-use"> </a></h
 </div>
 <div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
 <div class="text_cell_render border-box-sizing rendered_html">
-<h3 id="Command-line-utility-to-run-FireHR-for-an-event-as-outputed-by-BA-Net-post-processing">Command line utility to run FireHR for an event as outputed by BA-Net post-processing<a class="anchor-link" href="#Command-line-utility-to-run-FireHR-for-an-event-as-outputed-by-BA-Net-post-processing"> </a></h3><div class="highlight"><pre><span></span>firehr_from_banet_events ba100m_PT2020_218.tif
+<h4 id="Configuration-of-Google-Earth-Engine-API">Configuration of Google Earth Engine API<a class="anchor-link" href="#Configuration-of-Google-Earth-Engine-API"> </a></h4><p>Run the following python code and follow the link to generate the authentication file:</p>
+<div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">ee</span>
+<span class="n">ee</span><span class="o">.</span><span class="n">Authenticate</span><span class="p">()</span>
+</pre></div>
+<p>Once you are done you should see the message <code>Successfully saved authorization token.</code> and the file <code>~/.config/earthengine/credentials</code> should exist.</p>
+<p>Please refer to <a href="https://developers.google.com/earth-engine/guides/python_install">https://developers.google.com/earth-engine/guides/python_install</a> for more information about the GEE Python API.</p>
+
+</div>
+</div>
+</div>
+<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
+<div class="text_cell_render border-box-sizing rendered_html">
+<h4 id="Command-line-utility-to-run-FireHR-for-an-event-as-outputed-by-BA-Net-post-processing">Command line utility to run FireHR for an event as outputed by BA-Net post-processing<a class="anchor-link" href="#Command-line-utility-to-run-FireHR-for-an-event-as-outputed-by-BA-Net-post-processing"> </a></h4><div class="highlight"><pre><span></span>firehr_from_banet_events ba100m_PT2020_218.tif
 </pre></div>
 <p>Optional arguments:</p>
 <table>

nbs/index.ipynb

@@ -24,7 +24,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Install"
+    "## Install using pip"
    ]
   },
   {
@@ -34,6 +34,17 @@
     "`pip install FireHR`"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## Install from repo\n",
+    "```bash\n",
+    "git clone https://github.com/mnpinto/FireHR\n",
+    "cd FireHR; pip install -e .\n",
+    "```"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -45,7 +56,22 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "### Command line utility to run FireHR for an event as outputed by BA-Net post-processing\n",
+    "#### Configuration of Google Earth Engine API\n",
+    "Run the following python code and follow the link to generate the authentication file:\n",
+    "```python\n",
+    "import ee\n",
+    "ee.Authenticate()\n",
+    "```\n",
+    "Once you are done you should see the message `Successfully saved authorization token.` and the file `~/.config/earthengine/credentials` should exist. \n",
+    "\n",
+    "Please refer to https://developers.google.com/earth-engine/guides/python_install for more information about the GEE Python API. "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "#### Command line utility to run FireHR for an event as outputed by BA-Net post-processing\n",
     "```bash\n",
     "firehr_from_banet_events ba100m_PT2020_218.tif\n",
     "```\n",

settings.ini

@@ -8,7 +8,7 @@ author = Miguel Pinto
 author_email = mnpinto@fc.ul.pt
 copyright = Miguel Pinto
 branch = master
-version = 0.0.4
+version = 0.1.0
 min_python = 3.6
 audience = Developers
 language = English