Skip to content

Commit 0c987e9

Browse files
Update README.md
1 parent 607a27e commit 0c987e9

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.md

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -140,6 +140,63 @@ Table 1: Modules in `fimeval` are in order of execution.
140140

141141
Figure 4: Combined raw output from framework for different two method. First row (subplot a and b) and second row (subplot c and d) is contingency maps and evaluation metrics of FIM derived using `PrintContingencyMaP` and `PlotEvaluationMetrics` module. Third row (subplot e and f) is the output after processing and calculating of evaluation with BF by unsing `EvaluateWithBuildingFoorprint` module.
142142

143+
## 🔧 Installation Instructions
144+
145+
### 1. ✅ Prerequisites
146+
147+
Before installing `fimeval`, ensure the following software are installed:
148+
149+
- **Python**: Version 3.10 or higher
150+
- **Anaconda**: For managing environments and dependencies
151+
- **GIS Software**: For Visulalisation
152+
- [ArcGIS](https://www.esri.com/en-us/arcgis/products/index) or [QGIS](https://qgis.org/en/site/)
153+
- **Optional**:
154+
- [Google Earth Engine](https://earthengine.google.com/) account
155+
- Java Runtime Environment (for using GEE API)
156+
157+
---
158+
159+
### 2. Install Anaconda
160+
161+
If Anaconda is not installed, download and install it from the [official website](https://www.anaconda.com/products/distribution).
162+
163+
---
164+
165+
### 3. 🌐 Set Up Virtual Environment
166+
167+
#### 💻 For Mac Users
168+
169+
Open **Terminal** and run:
170+
```bash
171+
172+
# Create a new environment named 'fimeval'
173+
conda create --name fimeval python=3.10
174+
175+
# Activate the environment
176+
conda activate fimeval
177+
178+
# Install Jupyter Notebook
179+
pip install notebook
180+
181+
# Install fimeval package
182+
pip install fimeval
183+
184+
```
185+
186+
### ☁️ Google Colab Version
187+
188+
To use fimeval in Google Colab, follow the steps below:
189+
190+
## Upload Files
191+
Upload all necessary input files (e.g., raster, shapefiles, model outputs) to your Google Drive.
192+
## Open Google Colab
193+
Go to Google Colab and sign in with a valid Google account.
194+
## Mount Google Drive
195+
In a new Colab notebook, mount the Google Drive
196+
```bash
197+
pip install fimeval
198+
```
199+
143200
### **Acknowledgements**
144201
| | |
145202
| --- | --- |

0 commit comments

Comments
 (0)