Merge pull request #19 from supathdhitalGEO/main

Update the filename convention for forecasted data and, tool usage instructions in readme

Author: supathdhitalGEO

README.md

@@ -65,14 +65,30 @@ Although not mandatory,
 **we strongly recommend users create a virtual environment and install this package on that virtual environment to avoid the conflict between system dependencies and package dependencies.**
 
 **‼️ If your system doesnot have git, install it first. Download link of git for windows or MacOS: https://git-scm.com/downloads**
+
+**For conda users**
 ```bash
 #creating a virtual environment using conda
 conda create --name fimserve python==3.10
 
 #Activate environment
 conda activate fimserve
 ```
-**Install or add fimserve into your workflows**
+
+**If you don't have conda**
+```bash
+#create a virtual env using 'venv'
+python -m venv fimserve python==3.10
+
+#activate environment
+#For MAC Users
+source fimserve/bin/activate
+
+#For WINDOW Users
+fimserve\Scripts\activate
+```
+
+**Once Virtual env is ready, install or add fimserve into your workflows**
 ```bash
 #Using pip
 pip install fimserve

dist/fimserve-0.1.81-py3-none-any.whl

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "fimserve"
-version = "0.1.80"
+version = "0.1.81"
 description = "Framework which is developed with the purpose of quickly generating Flood Inundation Maps (FIM) for emergency response and risk assessment. It is developed under Surface Dynamics Modeling Lab (SDML)."
 authors = ["Supath Dhital <sdhital@crimson.ua.edu>"]
 license = "GPL-3.0"

dist/fimserve-0.1.81.tar.gz

@@ -217,7 +217,7 @@ def ProcessForecasts(
                 combined_df.groupby("feature_id")["discharge"].max().reset_index()
             )
 
-        sorted_file_name = f"{hour:02d}UTC_{forecast_range}_{group_date}.csv"
+        sorted_file_name = f"{hour:02d}UTC_{forecast_range}_{group_date}_{huc}.csv"
         sorted_file_path = os.path.join(data_dir, sorted_file_name)
         sorted_df.to_csv(sorted_file_path, index=False)
 

pyproject.toml

@@ -6,9 +6,9 @@
 
 # mention the forecast range as shortrange or mediumrange or longrange
 # Download the data if user wants to download the data for fixed date and hour otherwise it will download the data by taking current date and time fore forecasted data
-fm.getNWMForecasteddata(
-    huc, forecast_range="shortrange", forecast_date="2021-09-01", hour=6
-)
+# fm.getNWMForecasteddata(
+#     huc, forecast_range="shortrange", forecast_date="2021-09-01", hour=6
+# )
 
 # For current date and time forecasted data
 # fm.getNWMForecasteddata(huc, forecast_range="shortrange")
@@ -17,4 +17,4 @@
 # By default the data will be filtered based on maximum discharge value
 # Otherwise user need to mention
 
-# fm.getNWMForecasteddata(huc, forecast_range="longrange", sort_by="minimum")
+fm.getNWMForecasteddata(huc, forecast_range="longrange", sort_by="minimum")