Merge branch 'develop'

.gitignore

@@ -1,3 +1,5 @@
+result/
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]
@@ -82,7 +84,7 @@ profile_default/
 ipython_config.py
 
 # pyenv
-.python-version
+# .python-version
 
 # pipenv
 # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.

.python-version

@@ -0,0 +1 @@
+3.11.7

.vscode/extensions.json

@@ -0,0 +1,6 @@
+{
+ "recommendations": [
+ "ms-python.isort",
+ "ms-python.black-formatter",
+ ]
+}

.vscode/settings.json

@@ -0,0 +1,21 @@
+{
+ "editor.formatOnSave": true,
+ "editor.codeActionsOnSave": {
+ "source.organizeImports": "explicit"
+ },
+ "python.languageServer": "Pylance",
+ "python.testing.unittestEnabled": true,
+ "python.testing.pytestEnabled": false,
+ "python.terminal.activateEnvInCurrentTerminal": true,
+ "terminal.integrated.env.osx": {
+ "PYTHONPATH": "${workspaceFolder}"
+ },
+ "terminal.integrated.env.windows": {
+ "PYTHONPATH": "${workspaceFolder}"
+ },
+ "terminal.integrated.env.linux": {
+ "PYTHONPATH": "${workspaceFolder}"
+ },
+ "black-formatter.importStrategy": "fromEnvironment",
+ "isort.importStrategy": "fromEnvironment",
+}

README.md

@@ -1,7 +1,11 @@
 # ucgrb
+
+**[Click here for the README in English.](README_EN.md)**
+
 Gurobi Optimizerを用いた発電機起動停止計画（Unit Commitment: 以下UC）最適化を実施するためのPythonパッケージ。
 連系線で接続された複数地域の電力系統を対象としたUC最適化を実施することができる。
 
+
 ## 目次
 
 1. [特徴](docs/01_feature.md)
@@ -40,6 +44,7 @@ Gurobi Optimizerを用いた発電機起動停止計画（Unit Commitment: 以
  1. [原子力・火力発電機の燃料費関数出力比例係数算出方法](docs/04_formulation/06_appendix/01_fuel_cost.md)
  2. [原子力・火力発電機の最大出力・最小出力算出方法](docs/04_formulation/06_appendix/02_max_min_output.md)
  3. [大規模発電機のCO<sub>2</sub>排出量算出方法](docs/04_formulation/06_appendix/03_emission.md)
+ 4. [時間粒度の変更による定式内容の変化](docs/04_formulation/06_appendix/04_time_series_granularity.md)
 5. 電力系統データCSVファイルの記述方法
  1. [概要](docs/05_csvfile/01_about.md)
  2. [発電機データ](docs/05_csvfile/02_generation.md)
@@ -55,7 +60,7 @@ Gurobi Optimizerを用いた発電機起動停止計画（Unit Commitment: 以
 7. 開発者に向けて
  1. [開発者向け設定値](docs/07_for_developer/01_config_setting.md)
  2. [自動整形に関して](docs/07_for_developer/02_formatter.md)
-
+8. [v3で用いていた電力系統データCSVファイルからの変更方法](docs/08_how_to_modify_csvfile.md)
 
 
 ## ライセンス

README_EN.md

@@ -0,0 +1,65 @@
+# ucgrb
+
+**[README in JP](README.md)**
+
+This Python package can perform unit commitment (UC) optimization for multi-area power systems connected by tie lines using Gurobi Optimizer.
+
+
+## Table of contents
+
+1. [Feature](docs_en/01_feature.md)
+2. [Requirement](docs_en/02_requirement.md)
+3. Execution methods and examples
+ 1. If you have a Gurobi Optimizer license
+ 1. [Execution method](docs_en/03_01_run_with_licence/01_run.md)
+ 2. [Setting file examples](docs_en/03_01_run_with_licence/02_example.md)
+ 2. If you don't have a Gurobi Optimizer license
+ 1. [Execute on a small model](docs_en/03_02_run_without_licence/01_run.md)
+ 2. [Output MPS files, Execute in other solvers](docs_en/03_02_run_without_licence/02_mps.md)
+4. Formulation of the optimization problem
+ 1. [Objective function](docs_en/04_formulation/01_objective_function.md)
+ 2. Constraints
+ 1. [Constraints on area](docs_en/04_formulation/02_constraint/01_area.md)
+ 2. [Constraints on large-scale power generation](docs_en/04_formulation/02_constraint/02_generation.md)
+ 3. [Constraints on renewable energy](docs_en/04_formulation/02_constraint/03_re.md)
+ 4. [Constraints on energy storage system](docs_en/04_formulation/02_constraint/04_ess.md)
+ 5. [Constraints on tie line](docs_en/04_formulation/02_constraint/05_tie.md)
+ 6. [Constraints on rolling optimization](docs_en/04_formulation/02_constraint/06_inheritance.md)
+ 3. [Sets and indies](docs_en/04_formulation/03_set_and_index.md)
+ 4. Parameters
+ 1. [Parameters for area](docs_en/04_formulation/04_parameter/01_area.md)
+ 2. [Parameters for large-scale　power generation](docs_en/04_formulation/04_parameter/02_generator.md)
+ 3. [Parameters for renewable energy](docs_en/04_formulation/04_parameter/03_re.md)
+ 4. [Parameters for energy storage system](docs_en/04_formulation/04_parameter/04_ess.md)
+ 5. [Parameters for tie line](docs_en/04_formulation/04_parameter/05_tie.md)
+ 6. [Parameters that depends on scheduling kind](docs_en/04_formulation/04_parameter/06_depend_on_scheduling_kind.md)
+ 5. Variables
+ 1. [Variables for area](docs_en/04_formulation/05_variable/01_area.md)
+ 2. [Variables for large-scale　power generation](docs_en/04_formulation/05_variable/02_geneation.md)
+ 3. [Variables for renewable energy](docs_en/04_formulation/05_variable/03_re.md)
+ 4. [Variables for energy storage system](docs_en/04_formulation/05_variable/04_ess.md)
+ 5. [Variables for tie line](docs_en/04_formulation/05_variable/05_tie.md)
+ 6. Appendix
+ 1. [Fuel cost function coefficient calculation method for nuclear and thermal generators](docs_en/04_formulation/06_appendix/01_fuel_cost.md)
+ 2. [Maximum and minimum output calculation method for nuclear and thermal generators](docs_en/04_formulation/06_appendix/02_max_min_output.md)
+ 3. [CO<sub>2</sub> emission calculation method for nuclear and thermal generators](docs_en/04_formulation/06_appendix/03_emission.md)
+5. How to describe power system data CSV file
+ 1. [Overview](docs_en/05_csvfile/01_about.md)
+ 2. [Generation data](docs_en/05_csvfile/02_generation.md)
+ 3. [Area data](docs_en/05_csvfile/03_area.md)
+ 4. [Tie line data](docs_en/05_csvfile/04_tie.md)
+ 5. [Timeline data](docs_en/05_csvfile/05_timeline.md)
+6. List of setting values
+ 1. [How to describe a configuration file](docs_en/06_config/01_how_to_write.md)
+ 2. [Optional settings for input data and solver](docs_en/06_config/02_input_data_and_solver.md)
+ 3. [Unit commitment problem settings](docs_en/06_config/03_unit_commitment.md)
+ 4. [Rolling optimized list settings](docs_en/06_config/04_rolling_optimization_list.md)
+ 5. [Result output settings](docs_en/06_config/05_result_output.md)
+7. For Developers
+ 1. [Settings values for developers](docs_en/07_for_developer/01_config_setting.md)
+ 2. [About automatic formatting](docs_en/07_for_developer/02_formatter.md)
+
+
+## License
+
+[MIT License](LICENSE)