# NYgrid-python
<table>
<tr>
<td>Latest Release</td>
<td>
<a href="https://pypi.org/project/nygrid/">
<img src="https://img.shields.io/pypi/v/nygrid" alt="latest release" />
</a>
<a href="https://github.com/boyuan276/NYgrid-python/actions/workflows/python-publish.yml">
<img src="https://github.com/boyuan276/NYgrid-python/actions/workflows/python-publish.yml/badge.svg" alt="latest release" />
</a>
</td>
</tr>
<tr>
<td>Build Status</td>
<td>
<a href="https://nygrid-python.readthedocs.io/en/latest/">
<img src="https://readthedocs.org/projects/nygrid-python/badge/?version=latest" alt="documentation build status" />
</a>
<a href="https://github.com/boyuan276/NYgrid-python/actions/workflows/python-package.yml">
<img src="https://github.com/boyuan276/NYgrid-python/actions/workflows/python-package.yml/badge.svg" alt="python-package" />
</a>
<a href="https://github.com/boyuan276/NYgrid-python/actions/workflows/github-code-scanning/codeql">
<img src="https://github.com/boyuan276/NYgrid-python/actions/workflows/github-code-scanning/codeql/badge.svg" alt="codeql" />
</a>
</td>
</tr>
<tr>
<td>License</td>
<td>
<a href="https://github.com/boyuan276/NYgrid-python/blob/main/LICENSE">
<img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="license" />
</a>
</td>
</tr>
</table>
A python version of the NYgrid model.
It contains the following components:
* Optimal power flow (OPF) model
* Renewable integration
* Building electrification
* Battery storage
* Electric vehicle (EV) charging
## Documentation
Full documentation can be found at [readthedocs](https://nygrid-python.readthedocs.io/en/latest/).
## Installation
### Install using pip
The ``nygrid`` package can be installed using PIP.
```bash
pip install nygrid
```
### Install from the source
1. Install [Anaconda](https://www.anaconda.com/download/).
2. Install [Git](https://git-scm.com/downloads).
3. Clone the repository:
```bash
git clone https://github.com/boyuan276/NYgrid-python.git
```
4. Create a conda environment:
```bash
conda env create -f NYgrid-python.yml
```
5. Activate the environment:
```bash
conda activate NYgrid-python
```
6. Install the package:
```bash
pip install -e .
```
## Usage
1. Activate the environment:
```bash
conda activate NYgrid-python
```
2. Run the model:
- Go to the `examples` folder.
- Run the base year 2018 case:
```bash
python 01_opf_2018NewParams_daily.py
```
- Run the future year 2030 with policy scenarios:
```bash
# 1) 2030BaselineCase
python 02_opf_2030BaselineCase_daily.py
# 2) 2030ContractCase
python 03_opf_2030ContractCase_daily.py
# 3) 2030StateScenario
python 04_opf_2030StateScenario_daily.py
```
- Note: Generation and load properties and profiles need to be prepared before running these cases.
## Data
1. Generation data: See `examples/write_gen_prop_profiles_{case_name}.ipynb`.
2. Load data: See `examples/write_load_profiles_{case_name}.ipynb`.
## License
MIT license.
## See also
* [MATLAB version of the NYgrid model](https://github.com/AndersonEnergyLab-Cornell/NYgrid.git)
Raw data
{
"_id": null,
"home_page": "https://github.com/boyuan276/NYgrid-python",
"name": "nygrid",
"maintainer": "Bo Yuan",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "Bo Yuan <by276@cornell.edu>",
"keywords": "Power system, Renewable energy, Optimization",
"author": "The NYgrid-python Developers",
"author_email": "The NYgrid-python Developers <by276@cornell.edu>",
"download_url": "https://files.pythonhosted.org/packages/13/33/1afc880b86abcbd6a74cfa2a4a6df8870f02b269b3c2b2e056df949ec675/nygrid-0.1.2.tar.gz",
"platform": "Any",
"description": "# NYgrid-python\n\n<table>\n<tr>\n <td>Latest Release</td>\n <td>\n <a href=\"https://pypi.org/project/nygrid/\">\n <img src=\"https://img.shields.io/pypi/v/nygrid\" alt=\"latest release\" />\n </a>\n <a href=\"https://github.com/boyuan276/NYgrid-python/actions/workflows/python-publish.yml\">\n <img src=\"https://github.com/boyuan276/NYgrid-python/actions/workflows/python-publish.yml/badge.svg\" alt=\"latest release\" />\n </a>\n </td>\n</tr>\n<tr>\n <td>Build Status</td>\n <td>\n <a href=\"https://nygrid-python.readthedocs.io/en/latest/\">\n <img src=\"https://readthedocs.org/projects/nygrid-python/badge/?version=latest\" alt=\"documentation build status\" />\n </a>\n <a href=\"https://github.com/boyuan276/NYgrid-python/actions/workflows/python-package.yml\">\n <img src=\"https://github.com/boyuan276/NYgrid-python/actions/workflows/python-package.yml/badge.svg\" alt=\"python-package\" />\n </a>\n <a href=\"https://github.com/boyuan276/NYgrid-python/actions/workflows/github-code-scanning/codeql\">\n <img src=\"https://github.com/boyuan276/NYgrid-python/actions/workflows/github-code-scanning/codeql/badge.svg\" alt=\"codeql\" />\n </a>\n </td>\n</tr>\n<tr>\n <td>License</td>\n <td>\n <a href=\"https://github.com/boyuan276/NYgrid-python/blob/main/LICENSE\">\n <img src=\"https://img.shields.io/badge/License-MIT-blue.svg\" alt=\"license\" />\n </a>\n </td>\n</tr>\n</table>\n\nA python version of the NYgrid model.\n\nIt contains the following components:\n* Optimal power flow (OPF) model\n* Renewable integration\n* Building electrification\n* Battery storage\n* Electric vehicle (EV) charging\n\n## Documentation\n\nFull documentation can be found at [readthedocs](https://nygrid-python.readthedocs.io/en/latest/).\n\n## Installation\n\n### Install using pip\n\nThe ``nygrid`` package can be installed using PIP.\n\n```bash\npip install nygrid\n```\n\n### Install from the source\n\n1. Install [Anaconda](https://www.anaconda.com/download/).\n\n2. Install [Git](https://git-scm.com/downloads).\n\n3. Clone the repository: \n```bash\ngit clone https://github.com/boyuan276/NYgrid-python.git\n```\n\n4. Create a conda environment:\n```bash\nconda env create -f NYgrid-python.yml\n```\n\n5. Activate the environment:\n```bash\nconda activate NYgrid-python\n```\n\n6. Install the package:\n```bash\npip install -e .\n```\n\n## Usage\n\n1. Activate the environment:\n\n```bash\nconda activate NYgrid-python\n```\n\n2. Run the model:\n\n - Go to the `examples` folder.\n\n - Run the base year 2018 case:\n\n ```bash\n python 01_opf_2018NewParams_daily.py\n ```\n\n - Run the future year 2030 with policy scenarios:\n\n ```bash\n # 1) 2030BaselineCase\n python 02_opf_2030BaselineCase_daily.py\n\n # 2) 2030ContractCase\n python 03_opf_2030ContractCase_daily.py\n\n # 3) 2030StateScenario\n python 04_opf_2030StateScenario_daily.py\n ```\n\n - Note: Generation and load properties and profiles need to be prepared before running these cases.\n\n## Data\n\n1. Generation data: See `examples/write_gen_prop_profiles_{case_name}.ipynb`.\n\n2. Load data: See `examples/write_load_profiles_{case_name}.ipynb`.\n\n## License\n\nMIT license.\n\n\n## See also\n* [MATLAB version of the NYgrid model](https://github.com/AndersonEnergyLab-Cornell/NYgrid.git)\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "A python version of the NYgrid model",
"version": "0.1.2",
"project_urls": {
"Homepage": "https://github.com/boyuan276/NYgrid-python"
},
"split_keywords": [
"power system",
" renewable energy",
" optimization"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "d3afacd98c7f3fe1fccb8ccefb4f494ba84d7c3a3aaed19f7d81158347ea803a",
"md5": "3c52450abfb229a394c9714da26698d5",
"sha256": "86aebeb7ba3bd6f6f42e55f386bd0111b7bf3e45ff524f947b277a00db7cb64e"
},
"downloads": -1,
"filename": "nygrid-0.1.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3c52450abfb229a394c9714da26698d5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 36694,
"upload_time": "2024-12-13T01:21:04",
"upload_time_iso_8601": "2024-12-13T01:21:04.275174Z",
"url": "https://files.pythonhosted.org/packages/d3/af/acd98c7f3fe1fccb8ccefb4f494ba84d7c3a3aaed19f7d81158347ea803a/nygrid-0.1.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "13331afc880b86abcbd6a74cfa2a4a6df8870f02b269b3c2b2e056df949ec675",
"md5": "4654f3e13afbacf932c6a8dd84bf6ac6",
"sha256": "dc32e0a34a5705bfef07e1d943086989f7de2f7dc1432f44ea6ef129b4dcc8ef"
},
"downloads": -1,
"filename": "nygrid-0.1.2.tar.gz",
"has_sig": false,
"md5_digest": "4654f3e13afbacf932c6a8dd84bf6ac6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 36442,
"upload_time": "2024-12-13T01:21:06",
"upload_time_iso_8601": "2024-12-13T01:21:06.737145Z",
"url": "https://files.pythonhosted.org/packages/13/33/1afc880b86abcbd6a74cfa2a4a6df8870f02b269b3c2b2e056df949ec675/nygrid-0.1.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 01:21:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "boyuan276",
"github_project": "NYgrid-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "pytest",
"specs": [
[
"~=",
"7.3.1"
]
]
},
{
"name": "pandas",
"specs": [
[
"~=",
"1.5.3"
]
]
},
{
"name": "numpy",
"specs": [
[
"~=",
"1.22.4"
]
]
},
{
"name": "pyomo",
"specs": [
[
"~=",
"6.7.0"
]
]
},
{
"name": "pypower",
"specs": [
[
"~=",
"5.1.15"
]
]
},
{
"name": "geopandas",
"specs": [
[
"~=",
"0.12.2"
]
]
},
{
"name": "scikit-learn",
"specs": [
[
"~=",
"1.3.2"
]
]
},
{
"name": "setuptools",
"specs": [
[
"~=",
"69.0.3"
]
]
},
{
"name": "pypower",
"specs": [
[
"==",
"5.1.15"
]
]
},
{
"name": "openpyxl",
"specs": [
[
"~=",
"3.1.1"
]
]
},
{
"name": "sphinx",
"specs": [
[
"~=",
"7.1.2"
]
]
},
{
"name": "sphinx-rtd-theme",
"specs": [
[
"~=",
"3.0.2"
]
]
}
],
"lcname": "nygrid"
}
JSON
