Update README.md

README.md

@@ -1,20 +1,103 @@
----
-title: Analyzer
-emoji: 🚀
-colorFrom: red
-colorTo: red
-sdk: docker
-app_port: 8501
-tags:
-- streamlit
-pinned: false
-short_description: 'Reports '
-license: bigscience-bloom-rail-1.0
----
-
-# Welcome to Streamlit!
-
-Edit `/src/streamlit_app.py` to customize this app to your heart's desire. :heart:
-
-If you have any questions, checkout our [documentation](https://docs.streamlit.io) and [community
-forums](https://discuss.streamlit.io).
+# Charging Outlets Analytics Dashboard
+
+This Streamlit application helps you analyze charging outlet performance data and create insightful visualizations.
+
+## Features
+
+- **Data Upload**: Upload Sessions.xlsx and Overview.xlsx files containing charging session data
+- **Interactive Dashboard**: Visualize key metrics about charging outlets
+- **Filtering**: Filter data by specific areas
+- **PDF Export**: Generate downloadable PDF reports with visualizations
+
+## Dashboard Views
+
+1. **Key Metrics**
+   - Number of outlets per area
+   - kWh/month per area
+   - Total sessions and energy consumption
+
+2. **Utilization Analysis**
+   - Heatmap of outlet utilization (used outlet days / total outlet days)
+   - Detailed utilization metrics table
+
+3. **Energy Consumption Analysis**
+   - kWh per outlet per month per area
+   - Average kWh per session
+
+## Deployment on Hugging Face Spaces
+
+### Prerequisites
+
+- A Hugging Face account
+- Basic knowledge of Git
+
+### Deployment Steps
+
+1. Create a new Space on Hugging Face:
+   - Go to https://huggingface.co/spaces
+   - Click "Create new Space"
+   - Select "Streamlit" as the SDK
+   - Name your Space and set visibility options
+
+2. Clone the repository locally:
+   ```bash
+   git clone https://huggingface.co/spaces/YOUR-USERNAME/YOUR-SPACE-NAME
+   ```
+
+3. Add the application files to the repository:
+   - Copy `app.py` to the root of the repository
+   - Copy `requirements.txt` to the root of the repository
+
+4. Commit and push your changes:
+   ```bash
+   git add .
+   git commit -m "Initial application setup"
+   git push
+   ```
+
+5. Wait for the build to complete on Hugging Face Spaces
+
+6. Your application is now live at `https://huggingface.co/spaces/YOUR-USERNAME/YOUR-SPACE-NAME`
+
+## Data Format
+
+### Sessions.xlsx
+
+Contains charging session data with the following columns:
+- **Områdeskod**: Area code
+- **Område**: Area name
+- **Uttag**: Outlet identifier
+- **Startad**: Session start time
+- **Avslutad**: Session end time
+- **Laddat (kWh)**: Energy consumed in kWh
+- **Kostnad (exkl)**: Cost (excluding tax)
+- **Valuta**: Currency
+
+### Overview.xlsx
+
+Contains area and outlet information with the following columns:
+- **Namn**: Name
+- **Avtalskund**: Contract customer
+- **Synlighet**: Visibility
+- **Antal uttag**: Number of outlets
+- **Start fasta avgifter**: Start of fixed fees
+- **Fakturerbara ACAntal uttag**: Billable AC number of outlets
+- **Fakturerbara DCAntal uttag**: Billable DC number of outlets
+- **Kolumn1**: Additional column
+
+## Usage
+
+1. Upload both required files using the file uploaders in the sidebar
+2. Use the dropdown in the sidebar to filter by specific areas
+3. Navigate between tabs to view different dashboards
+4. Generate a PDF report using the button in the sidebar
+
+## Requirements
+
+- streamlit==1.27.0
+- pandas==2.0.3
+- plotly==5.17.0
+- numpy==1.25.2
+- reportlab==4.0.4
+- pillow==10.0.1
+- openpyxl==3.1.2