# SH-V2G-Simulator Docs

SH-V2G-Simulator is a toolset for solving optimal scheduling problems involving a large number of electric vehicles (EVs) participating in the Vehicle-to-Grid (V2G) program, implemented in MATLAB. The full simulator source code is available at [GitHub repository](https://github.com/CDSL-GitHub/SH-V2G-Simulator).

This project was developed by Control and Dynamic Systems Lab (CDSL) at Seoul National University. This work was supported by a grant from Hyundai Motor Company’s R&D Division.

---

This documentation consists of four parts:
- **User Guide**: It provides a comprehensive introduction to the project, including installation instructions, theoretical background, and overall architecture. This section also contains step-by-step tutorials to help new users get started quickly.
- **Source Codes**: This section documents all the major functions implemented in the project.
- **Classes and Utils**: This section documents the classes defining system representations and the utility functions that supports major functions.
- **Analyzer**: This section documents the Analyzer app.


## User Guide
- [Introduction](guide/intro.md)
- [Installation](guide/install.md)
- [Quick Demo](guide/quick_demo.md)
- [Problem Formulation](guide/prob_formulation.md)
- [Input Format and Preparation](guide/input.md)
- [Core Optimization Algorithms](guide/main.md)
- [Simulation and Analysis](guide/simulate_and_analyze.md)
- [Advanced Tutorials](guide/tutorial.md)

```{toctree}
:maxdepth: 2
:hidden:
:caption: User Guide

guide/intro
guide/install
guide/quick_demo
guide/prob_formulation
guide/input
guide/main
guide/simulate_and_analyze
guide/tutorial
```

## Source Codes
- [SRC](src/index.md)

```{toctree}
:maxdepth: 2
:hidden:
:caption: Source Codes

src/index
```

## Classes and Utils
- [CLASS](src/class/index.md)
- [UTILS](src/utils/index.md)

```{toctree}
:maxdepth: 2
:hidden:
:caption: Classes and Utils

src/class/index
src/utils/index
```

## App
- [analyze](app/analyze.md)

```{toctree}
:maxdepth: 2
:hidden:
:caption: App

app/analyze
```