Py-Microgrid Website

Website for the Py-Microgrid Python package - a comprehensive hybrid microgrid simulation and optimization platform built on NREL's HOPP framework.

🌟 About Py-Microgrid

Py-Microgrid is an open-source Python toolkit for designing, simulating, and optimizing hybrid microgrid systems. It integrates renewable energy sources (solar PV, wind), energy storage (batteries), and backup generation (gensets) to provide comprehensive energy system analysis.

Key Capabilities

• System Optimization: Multi-objective optimization for PV, wind, battery, and genset sizing
• Economic Analysis: LCOE, Net Present Cost, and CO2 emissions calculations
• Predictive Battery Dispatch: Intelligent energy management with up to 20% load reduction
• Multi-Location Processing: Batch analysis for multiple geographical locations
• HOPP Integration: Built on NREL's proven HOPP framework with real weather data
• Flexible Configuration: YAML-based configuration with extensive customization options

🚀 Quick Start

Running the Website Locally

1. Clone this website repository:

git clone https://github.com/Hanrong-Huang/py_microgrid_webpage.git
cd py_microgrid_webpage

2. Serve the website locally:

# Option 1: Using Python (recommended)
python -m http.server 8000

# Option 2: Using Node.js
npx http-server

# Option 3: Using PHP
php -S localhost:8000

# Option 4: Using Live Server (VS Code extension)
# Right-click index.html → "Open with Live Server"

3. View the website:
   • Open https://hanrong-huang.github.io/py_microgrid_webpage/ in your browser
   • Explore the interactive microgrid diagram and code examples

Using Py-Microgrid (Main Package)

To get started with the actual Py-Microgrid simulation package:

1. Install dependencies:

pip install HOPP
conda install -c conda-forge glpk coin-or-cbc -y

2. Clone the main Py-Microgrid repository:

git clone https://github.com/Hanrong-Huang/Py-Microgrid.git
cd Py-Microgrid

3. Get NREL API key:

   • Sign up at developer.nrel.gov/signup
   • Copy your API key for use in the examples

4. Run the quick start example:

   • Open py_microgrid/quick_start_example.ipynb in Jupyter
   • Follow the step-by-step tutorial

Website Structure

/
├── index.html              # Main homepage
├── assets/
│   ├── css/
│   │   ├── main.css        # Base styles and utilities
│   │   └── components.css  # Component-specific styles
│   ├── js/
│   │   └── main.js         # Interactive functionality
│   ├── images/             # Image assets
│   └── fonts/              # Custom fonts
├── docs/                   # Documentation pages
├── examples/               # Example pages
├── api/                    # API documentation
└── .github/
    └── workflows/
        └── deploy.yml      # GitHub Actions deployment

🔗 Related Resources

Main Py-Microgrid Project

• 📦 Main Repository - The core Python package
• 📓 Quick Start Notebook - Jupyter tutorial
• 📖 Documentation - Comprehensive guide

Website & Deployment

• 🌐 Live Website - Production site
• ⚡ GitHub Pages - Hosting platform
• 🔄 GitHub Actions - Automated deployment

External Dependencies

• 🏢 NREL HOPP - Hybrid optimization framework
• 🔑 NREL Developer API - Weather and resource data

📄 License & Attribution

This website showcases the open-source Py-Microgrid project. The main Py-Microgrid package is licensed under the BSD 3-Clause License.

Built with ❤️ for the renewable energy community

---

For questions about the Py-Microgrid package itself, please visit the main repository or contact hanrong.huang@unsw.edu.au