{"id":361549,"name":"PyPSA-China","description":"A open-source model of the Chinese energy system covering electricity and heat that co-optimizes dispatch and investments under user-set constraints, such as limits to environmental impacts, to minimize costs.","url":"https://github.com/pypsa/pypsa-china","last_synced_at":"2026-08-13T14:02:42.700Z","repository":{"id":263853324,"uuid":"884360927","full_name":"PyPSA/PyPSA-China","owner":"PyPSA","description":"PyPSA-China: An Open Optimisation model of the Chinese Energy System","archived":false,"fork":false,"pushed_at":"2026-07-14T09:32:03.000Z","size":182599,"stargazers_count":37,"open_issues_count":6,"forks_count":11,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-08-06T04:49:02.259Z","etag":null,"topics":["energy-system-model","optimisation"],"latest_commit_sha":null,"homepage":"https://pypsa.github.io/PyPSA-China/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"Xiaowei-Z/PyPSA-China","license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/PyPSA.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSES/CC-BY-4.0.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2024-11-06T16:00:45.000Z","updated_at":"2026-07-21T08:32:55.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/PyPSA/PyPSA-China","commit_stats":null,"previous_names":["pik-piam/pypsa-china-pik","pypsa/pypsa-china"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/PyPSA/PyPSA-China","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyPSA%2FPyPSA-China","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyPSA%2FPyPSA-China/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyPSA%2FPyPSA-China/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyPSA%2FPyPSA-China/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PyPSA","download_url":"https://codeload.github.com/PyPSA/PyPSA-China/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/PyPSA%2FPyPSA-China/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":36329232,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-08-06T04:43:03.162Z","status":"ssl_error","status_checked_at":"2026-08-06T04:43:02.660Z","response_time":54,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"owner":{"login":"PyPSA","name":"PyPSA","uuid":"32890768","kind":"organization","description":"Python for Power System Analysis","email":null,"website":"www.pypsa.org","location":null,"twitter":null,"company":null,"icon_url":"https://avatars.githubusercontent.com/u/32890768?v=4","repositories_count":29,"last_synced_at":"2024-03-26T13:25:46.062Z","metadata":{"has_sponsors_listing":false},"html_url":"https://github.com/PyPSA","funding_links":[],"total_stars":2199,"followers":206,"following":0,"created_at":"2022-11-03T20:08:34.285Z","updated_at":"2024-03-26T13:25:46.341Z","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PyPSA","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/PyPSA/repositories"},"packages":[],"commits":{"id":11923917,"full_name":"pypsa/pypsa-china","default_branch":"master","total_commits":995,"total_committers":5,"total_bot_commits":5,"total_bot_committers":1,"mean_commits":199.0,"dds":0.19798994974874373,"past_year_total_commits":251,"past_year_total_committers":3,"past_year_total_bot_commits":0,"past_year_total_bot_committers":0,"past_year_mean_commits":83.66666666666667,"past_year_dds":0.3545816733067729,"last_synced_at":"2026-08-11T01:04:42.717Z","last_synced_commit":"3ba042b201470e1f8b74e4356247565b4f8aee0d","created_at":"2026-07-19T01:01:32.759Z","updated_at":"2026-08-11T01:04:42.656Z","committers":[{"name":"irr-github","email":"ivan.ramirez@pik-potsdam.de","login":"irr-github","count":798},{"name":"beijingzyl","email":"1772066848@qq.com","login":"beijingzyl","count":176},{"name":"Xiaowei-Z","email":"jizhouxw@sjtu.edu.cn","login":"Xiaowei-Z","count":14},{"name":"pre-commit-ci[bot]","email":"66853113+pre-commit-ci[bot]","login":"pre-commit-ci[bot]","count":5},{"name":"Songmin","email":"yu.ceepcas@gmail.com","login":"SongminYu","count":2}],"past_year_committers":[{"name":"irr-github","email":"ivan.ramirez@pik-potsdam.de","login":"irr-github","count":162},{"name":"beijingzyl","email":"1772066848@qq.com","login":"beijingzyl","count":87},{"name":"Songmin","email":"yu.ceepcas@gmail.com","login":"SongminYu","count":2}],"commits_url":"https://commits.ecosyste.ms/api/v1/hosts/GitHub/repositories/pypsa%2Fpypsa-china/commits","host":{"name":"GitHub","url":"https://github.com","kind":"github","last_synced_at":"2026-08-11T00:00:06.485Z","repositories_count":6628098,"commits_count":918444270,"contributors_count":39027643,"owners_count":1331055,"committers_count":3292488,"icon_url":"https://github.com/github.png","host_url":"https://commits.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://commits.ecosyste.ms/api/v1/hosts/GitHub/repositories"}},"issues_stats":{"full_name":"pypsa/pypsa-china","html_url":"https://github.com/pypsa/pypsa-china","last_synced_at":"2026-08-10T05:18:54.091Z","status":"error","issues_count":3,"pull_requests_count":56,"avg_time_to_close_issue":null,"avg_time_to_close_pull_request":905667.3636363636,"issues_closed_count":0,"pull_requests_closed_count":55,"pull_request_authors_count":2,"issue_authors_count":1,"avg_comments_per_issue":0.0,"avg_comments_per_pull_request":0.07142857142857142,"merged_pull_requests_count":55,"bot_issues_count":0,"bot_pull_requests_count":0,"past_year_issues_count":0,"past_year_pull_requests_count":14,"past_year_avg_time_to_close_issue":null,"past_year_avg_time_to_close_pull_request":445151.3076923077,"past_year_issues_closed_count":0,"past_year_pull_requests_closed_count":13,"past_year_pull_request_authors_count":2,"past_year_issue_authors_count":0,"past_year_avg_comments_per_issue":null,"past_year_avg_comments_per_pull_request":0.07142857142857142,"past_year_bot_issues_count":0,"past_year_bot_pull_requests_count":0,"past_year_merged_pull_requests_count":13,"created_at":"2026-07-19T01:01:33.967Z","updated_at":"2026-08-10T05:18:54.092Z","repository_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories/pypsa%2Fpypsa-china","issues_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories/pypsa%2Fpypsa-china/issues","issue_labels_count":{"enhancement":3,"Post-process":1},"pull_request_labels_count":{"enhancement":28,"bug":16,"documentation":8,"Post-process":4,"invalid":3,"Remind-coupling":3,"data":1},"issue_author_associations_count":{"COLLABORATOR":3},"pull_request_author_associations_count":{"COLLABORATOR":43,"CONTRIBUTOR":13},"issue_authors":{"irr-github":3},"pull_request_authors":{"irr-github":43,"beijingzyl":13},"host":{"name":"GitHub","url":"https://github.com","kind":"github","last_synced_at":"2026-08-10T00:00:23.081Z","repositories_count":14797774,"issues_count":28540511,"pull_requests_count":94259994,"authors_count":11426581,"icon_url":"https://github.com/github.png","host_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/repositories","owners_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/owners","authors_url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/authors"},"past_year_issue_labels_count":{},"past_year_pull_request_labels_count":{"bug":4,"enhancement":3,"data":1,"documentation":1},"past_year_issue_author_associations_count":{},"past_year_pull_request_author_associations_count":{"CONTRIBUTOR":7,"COLLABORATOR":2},"past_year_issue_authors":{},"past_year_pull_request_authors":{"beijingzyl":7,"irr-github":2},"maintainers":[{"login":"irr-github","count":46,"url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/authors/irr-github"}],"active_maintainers":[{"login":"irr-github","count":2,"url":"https://issues.ecosyste.ms/api/v1/hosts/GitHub/authors/irr-github"}]},"events":{"total":{"PushEvent":1},"last_year":{"PushEvent":1}},"keywords":["energy-system-model","optimisation"],"dependencies":[],"score":5.3706380281276624,"created_at":"2026-07-14T00:06:25.708Z","updated_at":"2026-08-13T14:02:42.702Z","avatar_url":"https://github.com/PyPSA.png","language":"Python","category":"Energy Systems","sub_category":"Global and Regional Energy System Models","monthly_downloads":0,"total_dependent_repos":0,"total_dependent_packages":0,"readme":"# PyPSA-China：An Open-Source Optimisation model of the Chinese Energy System\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Documentation](https://img.shields.io/badge/docs-latest-blue.svg)](https://pik-piam.github.io/PyPSA-China-PIK/)\n[![GitHub release](https://img.shields.io/github/v/release/pik-piam/PyPSA-China-PIK)](https://github.com/pik-piam/PyPSA-China-PIK/releases)\n\nPyPSA-China (PIK) is a open-source model of the Chinese energy system covering electricity and heat. It co-optimizes dispatch and investments under user-set constraints, such as limits to environmental impacts, to minimize costs. The model works at provincial resolution and can simulate a full year at hourly resolution.\n\n## PIK version\nThis is the PIK implementation of the PyPSA-China power model, first published by Hailiang Liu et al for their study of [hydro-power in china](https://doi.org/10.1016/j.apenergy.2019.02.009) and extended by Xiaowei Zhou et al for their  [\"Multi-energy system horizon planning: Early decarbonisation in China avoids stranded assets\"](doi.org/10.1049/ein2.12011) paper. It is adapted from the Zhou version by the [PIK RD3-ETL team](https://www.pik-potsdam.de/en/institute/labs/energy-transition/energy-transition-lab), with the aim of coupling it to the [REMIND](https://www.pik-potsdam.de/en/institute/departments/transformation-pathways/models/remind) integrated assessment model. A reference guide is available as part of the [documentation](https://pik-piam.github.io/PyPSA-China-PIK/).\n\n## Overview\nPyPSA-China should be understood as a modelling worklow, using snakemake as workflow manager, around the [PyPSA python power system analysis](https://pypsa.org/) package. The workflow collects data, builds the power system network and plots the results. It is akin to its more mature sister project, [PyPSA-EUR](https://github.com/PyPSA/pypsa-eur), from which it is derived.\n\nUnlike PyPSA-EUR, which simplifies high resolution electricity grid data to a user-defined network size, the PyPSA-China network is currently fixed to one node per province (with a 340 node version in the works). This is in large part due to data availability issues.\n\nThe PyPSA can perform a number of different study types (investment decision, operational decisions, simulate AC power flows). Currently only capacity expansion problems are explicitly implemented in PyPSA-China.\n\nThe PyPSA-CHINA-PIK is currently under development. Please contact us if you intend to use it for publications.\n\n## Quick Links\n\n- 📖 [Documentation](https://pik-piam.github.io/PyPSA-China-PIK/)\n- 📝 [Changelog](CHANGELOG.md)\n- 🚀 [Releases](https://github.com/pik-piam/PyPSA-China-PIK/releases)\n- 🤝 [Contributing Guide](CONTRIBUTING.md)\n- 📋 [Release Guide](docs/release-guide.md) (for maintainers)\n\n# License\nThe code is released under the [MIT license](https://github.com/irr-github/PyPSA-China-PIK/blob/main/LICENSES/MIT.txt), however some of the data used is more restrictive. \n\n# Documentation\nThe documentation can be found at https://pik-piam.github.io/PyPSA-China-PIK/\n\n# Getting started\n\n## Installation\n\nAn installation guide is provided at https://pik-piam.github.io/PyPSA-China-PIK/ \n\n## Getting the data\nYou will need to enable data retrieval in the config\n```yaml\nenable:\n  build_cutout: false # if you want to build your own (requires ERA5 api access)\n  retrieve_cutout: true # if you want to download the pre-computed one from zenodo\n  retrieve_raster: true # get raster data\n```\nSome of the files are very large - expect a slow process!\n\n- You can also download the data manually and  copy it over to the correct folder. The source and target destinations are the input/output of the `fetch_` rules in `workflow/rules/fetch_data.smk`\n- **PIK HPC users only** you can also copy the data from other users\n\n## Usage\n\nDetailed instructions in the documentation. \n### local execution\n- local execution can be started (once the environment is activated) with `snakemake`\n- to customize the options, create `my_config.yaml` and launch `snakemake --configfile `my_config.yaml`. Configuration options are summarised in the documentation.\n### Remote execution\nThis is relevant for slurm HPCs and other remotes with a submit job command\n- The workflow can be launched with `snakemake --profile config/compute_profile`\n- [PIK HPC users only] use `snakemake --profile config/pik_hpc_profile`\n- If you are not running on the PIK hpc, you will need make a new profile for your machine under `config/\u003ccompute_profile\u003e/config.yaml`\n\n\n\n\n","funding_links":[],"readme_doi_urls":["https://doi.org/10.1016/j.apenergy.2019.02.009"],"works":{},"citation_counts":{},"total_citations":0,"keywords_from_contributors":[],"project_url":"https://ost.ecosyste.ms/api/v1/projects/361549","html_url":"https://ost.ecosyste.ms/projects/361549"}