diff --git a/.models/model512.pth b/.models/model512.pth deleted file mode 100644 index 5b79917..0000000 Binary files a/.models/model512.pth and /dev/null differ diff --git a/FireHR/__init__.py b/FireHR/__init__.py index 81f0fde..3dc1f76 100644 --- a/FireHR/__init__.py +++ b/FireHR/__init__.py @@ -1 +1 @@ -__version__ = "0.0.4" +__version__ = "0.1.0" diff --git a/FireHR/core.py b/FireHR/core.py deleted file mode 100644 index 3d542c9..0000000 --- a/FireHR/core.py +++ /dev/null @@ -1,3 +0,0 @@ -# AUTOGENERATED! DO NOT EDIT! File to edit: nbs/00_core.ipynb (unless otherwise specified). - -__all__ = [] \ No newline at end of file diff --git a/README.md b/README.md index 3911e66..88aebcf 100644 --- a/README.md +++ b/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 ``` diff --git a/docs/Untitled.html b/docs/Untitled.html deleted file mode 100644 index 3d82123..0000000 --- a/docs/Untitled.html +++ /dev/null @@ -1,34 +0,0 @@ ---- - -title: Title - - -keywords: fastai -sidebar: home_sidebar - - - -nb_path: "nbs/Untitled.ipynb" ---- - - -
- - {% raw %} - -
- -
- {% endraw %} - -
- - diff --git a/docs/core.html b/docs/core.html deleted file mode 100644 index 2f0a138..0000000 --- a/docs/core.html +++ /dev/null @@ -1,51 +0,0 @@ ---- - -title: Title - - -keywords: fastai -sidebar: home_sidebar - - - -nb_path: "nbs/00_core.ipynb" ---- - - -
- - {% raw %} - -
- -
- {% endraw %} - - {% raw %} - -
-
- -
-
-
> API details.
-
- -
-
-
- -
- {% endraw %} - -
- - diff --git a/docs/index.html b/docs/index.html index bd880bf..2961e9a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -31,7 +31,7 @@
-

Install

+

Install using pip

@@ -39,6 +39,15 @@

Install

pip install FireHR

+
+ + +
+
+

Install from repo 

git clone https://github.com/mnpinto/FireHR
+cd FireHR; pip install -e .
+
+
@@ -50,7 +59,19 @@

How to use
-

Command line utility to run FireHR for an event as outputed by BA-Net post-processing 

firehr_from_banet_events ba100m_PT2020_218.tif
+
Configuration of Google Earth Engine API 
Run the following python code and follow the link to generate the authentication file:

+
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 

firehr_from_banet_events ba100m_PT2020_218.tif

Optional arguments:

diff --git a/nbs/index.ipynb b/nbs/index.ipynb index b2a5f7c..cd8b08b 100644 --- a/nbs/index.ipynb +++ b/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", diff --git a/settings.ini b/settings.ini index 5f550dd..0cee511 100644 --- a/settings.ini +++ b/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