Merge remote-tracking branch 'origin/main'

# Conflicts:
#	docs/source/notebooks/example_brazil.ipynb

Author: ingridvmoras

README.md

@@ -1,7 +1,14 @@
-<a href='https://harmonize-tools.github.io/socio4health/'><img height="100" src="https://raw.githubusercontent.com/harmonize-tools/socio4health/main/docs/source/_static/image.png"/></a>
 
-# socio4health <a href='https://www.harmonize-tools.org/'><img height="139" src="https://harmonize-tools.github.io/harmonize-logo.png"/></a>
+<a href="https://www.harmonize-tools.org/">
+    <img height="120" align="right" src="https://harmonize-tools.github.io/harmonize-logo.png" />
+</a>
+
+<a href="https://harmonize-tools.github.io/socio4health/">
+    <img height="120" src="https://raw.githubusercontent.com/harmonize-tools/socio4health/main/docs/source/_static/image.png" />
+</a>
 
+# socio4health
+                                                             
 <!-- badges: start -->
 
 [![Lifecycle:
@@ -13,22 +20,31 @@ contributors](https://img.shields.io/github/contributors/harmonize-tools/socio4h
 ![commits](https://badgen.net/github/commits/harmonize-tools/socio4health/main)
 <!-- badges: end -->
 
-## Overview
+## Overview  
 <p style="font-family: Arial, sans-serif; font-size: 14px;">
-  Package socio4health is an extraction, transformation, loading (ETL), and AI-assisted query and visualization (AI QV) tool designed to simplify the intricate process of collecting and merging data 📊 from multiple sources, focusing on sociodemographic and census datasets from Colombia, Brazil, and Peru, into a unified relational database structure.
+  Package socio4health is an extraction, transformation and loading (ETL)  classification tool designed to simplify the intricate process of collecting and merging data from multiple sources, focusing on sociodemographic and census datasets from Colombia, Brazil, and Peru, into a harmonized dataset.
 </p>
 
 - Seamlessly retrieve data from online data sources through web scraping, as well as from local files.
-- Support for various data formats, including `.csv`, `.xlsx`, `.xls`, `.txt`, `.sav`, and compressed files, ensuring versatility in sourcing information.
-- Consolidating extracted data into a pandas DataFrame.
-- Consolidating transformed data into a cohesive relational database.
-- Conduct precise queries and apply transformations to meet specific criteria.
+- Support for various data formats, including `.csv`, `.xlsx`, `.xls`, `.txt`, `.sav`, fixed-width files and geospatial files, ensuring versatility in sourcing information.
+- Consolidating extracted data into a pandas (or dask) DataFrame.
 
 
 
 ## Dependencies
 
 <table>
+  <tr>
+    <td align="center">
+      <a href="https://www.dask.org/" target="_blank">
+        <img src="https://avatars.githubusercontent.com/u/17131925?s=200&v=4" height="50" alt="pandas logo">
+      </a>
+    </td>
+    <td align="left">
+      <strong>Dask</strong><br>
+     Dask is a flexible parallel computing library for analytics.<br>
+    </td>
+  </tr>
   <tr>
     <td align="center">
       <a href="https://pandas.pydata.org/" target="_blank">
@@ -37,7 +53,18 @@ contributors](https://img.shields.io/github/contributors/harmonize-tools/socio4h
     </td>
     <td align="left">
       <strong>Pandas</strong><br>
-      Pandas is a fast, powerful, flexible, and easy-to-use open source data analysis and manipulation tool.<br>
+      Pandas is a well-known open source data analysis and manipulation tool.<br>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <a href="https://geopandas.org/" target="_blank">
+        <img src="https://avatars.githubusercontent.com/u/8130715?s=48&v=4" height="50" alt="pandas logo">
+      </a>
+    </td>
+    <td align="left">
+      <strong>Geopandas</strong><br>
+     Python tools for geographic data.<br>
     </td>
   </tr>
   <tr>
@@ -62,19 +89,46 @@ contributors](https://img.shields.io/github/contributors/harmonize-tools/socio4h
       Framework for extracting the data you need from websites.<br>
     </td>
   </tr>
+  <tr>
+    <td align="center">
+      <a href="https://matplotlib.org/" target="_blank">
+        <img src="https://avatars.githubusercontent.com/u/215947?s=48&v=4" height="50" alt="scrapy logo">
+      </a>
+    </td>
+    <td align="left">
+      <strong>Matplotlib</strong><br>
+      Library for creating static, animated, and interactive visualizations in Python.<br>
+    </td>
+  </tr>
+  <tr>
+    <td align="center">
+      <a href="https://pytorch.org/" target="_blank">
+        <img src="https://avatars.githubusercontent.com/u/21003710?s=48&v=4" height="50" alt="scrapy logo">
+      </a>
+    </td>
+    <td align="left">
+      <strong>Torch</strong><br>
+      Python package for tensor computation and deep neural networks.<br>
+    </td>
+  </tr>
 </table>
 
 - <a href="https://openpyxl.readthedocs.io/en/stable/">openpyxl</a>
 - <a href="https://py7zr.readthedocs.io/en/latest/">py7zr</a>
 - <a href="https://pypi.org/project/pyreadstat/">pyreadstat</a>
 - <a href="https://tqdm.github.io/">tqdm</a>
 - <a href="https://requests.readthedocs.io/en/latest/">requests</a>
+- <a href="https://pypi.org/project/appdirs/">appdirs</a>
+- <a href="https://pypi.org/project/pyarrow/">pyarrow</a>
+- <a href="https://pypi.org/project/deep-translator/">deep_translator</a>
+- <a href="https://pypi.org/project/transformers/">transformers</a>
+- <a href="https://pypi.org/project/pytest/">pytest</a>
 
 ## Installation
 
 **socio4health** can be installed via pip from [PyPI](https://pypi.org/project/socio4health/).
 
-```python
+``` CMD
 # Install using pip
 pip install socio4health
 ```
@@ -106,6 +160,8 @@ To use the socio4health package, follow these steps:
    harmonizer = Harmonizer()
    ```
 
+For more detailed examples and use cases, please refer to the [socio4health documentation](https://harmonize-tools.github.io/socio4health/).
+
 ## Resources
 
 <details>

docs/source/_static/image.png

@@ -6,7 +6,7 @@ Welcome to the Getting Started section of **socio4health**. This guide will walk
 Installation
 ------------
 
-**socio4health** can be installed via pip from `PyPI<https://pypi.org/project/socio4health/>`_. To install the package, run the following command in your terminal:
+**socio4health** can be installed via pip from `PyPI <https://pypi.org/project/socio4health/>`_ . To install the package, run the following command in your terminal:
 
 .. code-block:: shell
 

docs/source/getting_started.rst

@@ -50,7 +50,7 @@ Welcome to the official documentation site for **socio4health**\! This site serv
 Introduction
 ------------
 
-The Python package **socio4health** is an **extraction**, **transformation**, **loading**, and **AI-assisted query** and **visualization** (ETL-AI QV) tool designed to simplify the process of collecting and merging data from multiple sources into a unified relational database structure, and to visualize or query it using natural language.
+The Python package **socio4health** is an **extraction**, **transformation**,and **loading** tool designed to simplify the process of collecting and merging data from multiple sources into a unified database structure.
 
 Features
 --------
@@ -68,15 +68,12 @@ Features
 
 * **Load:**
 
-  * Consolidate transformed data into a cohesive relational database.
+  * Consolidate transformed data into a cohesive database.
 
 * **Query:**
 
   * Conduct precise queries and apply transformations to meet specific criteria.
 
-* **AI Query & Visualization:**
-
-  * Use natural language input to query data (from values to subsets).
 
 Who should use socio4health?
 ----------------------------