From 1065684ee193c2e8632e4c30af8c626735678edb Mon Sep 17 00:00:00 2001 From: Ray Zimmerman Date: Thu, 21 Mar 2024 15:17:32 -0600 Subject: [PATCH] Add Sphinx-based Reference documentation. --- CHANGES.md | 3 + docs/sphinx/source/conf.py | 40 ++++-- docs/sphinx/source/functions/addgen2mpc.rst | 8 ++ docs/sphinx/source/functions/addstorage.rst | 8 ++ docs/sphinx/source/functions/addwind.rst | 8 ++ .../sphinx/source/functions/apply_profile.rst | 8 ++ docs/sphinx/source/functions/c118swf.rst | 8 ++ docs/sphinx/source/functions/ex_case3a.rst | 8 ++ docs/sphinx/source/functions/ex_case3b.rst | 8 ++ docs/sphinx/source/functions/ex_contab.rst | 8 ++ .../source/functions/ex_load_profile.rst | 8 ++ docs/sphinx/source/functions/ex_storage.rst | 8 ++ docs/sphinx/source/functions/ex_transmat.rst | 8 ++ docs/sphinx/source/functions/ex_wind.rst | 8 ++ .../source/functions/ex_wind_profile.rst | 8 ++ .../source/functions/ex_wind_profile_d.rst | 8 ++ docs/sphinx/source/functions/ex_wind_uc.rst | 8 ++ docs/sphinx/source/functions/ex_xgd.rst | 8 ++ docs/sphinx/source/functions/ex_xgd_ramp.rst | 8 ++ docs/sphinx/source/functions/ex_xgd_res.rst | 8 ++ docs/sphinx/source/functions/ex_xgd_uc.rst | 8 ++ .../functions/filter_ramp_transitions.rst | 8 ++ docs/sphinx/source/functions/getprofiles.rst | 8 ++ docs/sphinx/source/functions/idx_profile.rst | 8 ++ .../source/functions/loadgenericdata.rst | 8 ++ docs/sphinx/source/functions/loadmd.rst | 8 ++ .../source/functions/loadstoragedata.rst | 8 ++ docs/sphinx/source/functions/loadxgendata.rst | 8 ++ docs/sphinx/source/functions/md_init.rst | 8 ++ docs/sphinx/source/functions/most.rst | 8 ++ docs/sphinx/source/functions/most_ex1_ed.rst | 8 ++ .../source/functions/most_ex2_dcopf.rst | 8 ++ .../source/functions/most_ex3_dcopf_w_uc.rst | 8 ++ .../source/functions/most_ex4_dcopf_ss.rst | 8 ++ .../source/functions/most_ex5_mpopf.rst | 8 ++ docs/sphinx/source/functions/most_ex6_uc.rst | 8 ++ docs/sphinx/source/functions/most_ex7_suc.rst | 8 ++ docs/sphinx/source/functions/most_summary.rst | 8 ++ docs/sphinx/source/functions/mostver.rst | 8 ++ .../source/functions/mpoption_info_most.rst | 8 ++ docs/sphinx/source/functions/plot_gen.rst | 8 ++ docs/sphinx/source/functions/plot_storage.rst | 8 ++ docs/sphinx/source/functions/plot_uc.rst | 8 ++ docs/sphinx/source/functions/plot_uc_data.rst | 8 ++ .../sphinx/source/functions/t_case30_most.rst | 8 ++ docs/sphinx/source/functions/t_case3_most.rst | 8 ++ docs/sphinx/source/functions/t_case_tlmp.rst | 8 ++ .../source/functions/t_case_tlmp_storage.rst | 8 ++ .../source/functions/t_most_30b_1_1_0.rst | 8 ++ .../source/functions/t_most_30b_1_1_0_uc.rst | 8 ++ .../source/functions/t_most_30b_1_1_17.rst | 8 ++ .../source/functions/t_most_30b_3_1_0.rst | 8 ++ .../source/functions/t_most_30b_3_1_17.rst | 8 ++ .../source/functions/t_most_3b_1_1_0.rst | 8 ++ .../source/functions/t_most_3b_1_1_2.rst | 8 ++ .../source/functions/t_most_3b_3_1_0.rst | 8 ++ .../source/functions/t_most_3b_3_1_2.rst | 8 ++ .../source/functions/t_most_fixed_res.rst | 8 ++ docs/sphinx/source/functions/t_most_mpopf.rst | 8 ++ docs/sphinx/source/functions/t_most_sp.rst | 8 ++ docs/sphinx/source/functions/t_most_spuc.rst | 8 ++ docs/sphinx/source/functions/t_most_suc.rst | 8 ++ docs/sphinx/source/functions/t_most_tlmp.rst | 8 ++ docs/sphinx/source/functions/t_most_uc.rst | 8 ++ docs/sphinx/source/functions/t_most_w_ds.rst | 8 ++ docs/sphinx/source/functions/test_most.rst | 8 ++ .../source/functions/uniformwindprofile.rst | 8 ++ docs/sphinx/source/index.rst | 18 ++- .../source/matlab-source/most/addgen2mpc.m | 1 + .../source/matlab-source/most/addstorage.m | 1 + .../source/matlab-source/most/addwind.m | 1 + .../source/matlab-source/most/apply_profile.m | 1 + .../source/matlab-source/most/c118swf.m | 1 + .../source/matlab-source/most/ex_case3a.m | 1 + .../source/matlab-source/most/ex_case3b.m | 1 + .../source/matlab-source/most/ex_contab.m | 1 + .../matlab-source/most/ex_load_profile.m | 1 + .../source/matlab-source/most/ex_storage.m | 1 + .../source/matlab-source/most/ex_transmat.m | 1 + .../source/matlab-source/most/ex_wind.m | 1 + .../matlab-source/most/ex_wind_profile.m | 1 + .../matlab-source/most/ex_wind_profile_d.m | 1 + .../source/matlab-source/most/ex_wind_uc.m | 1 + .../sphinx/source/matlab-source/most/ex_xgd.m | 1 + .../source/matlab-source/most/ex_xgd_ramp.m | 1 + .../source/matlab-source/most/ex_xgd_res.m | 1 + .../source/matlab-source/most/ex_xgd_uc.m | 1 + .../most/filter_ramp_transitions.m | 1 + .../source/matlab-source/most/getprofiles.m | 1 + .../source/matlab-source/most/idx_profile.m | 1 + .../matlab-source/most/loadgenericdata.m | 1 + .../sphinx/source/matlab-source/most/loadmd.m | 1 + .../matlab-source/most/loadstoragedata.m | 1 + .../source/matlab-source/most/loadxgendata.m | 1 + .../source/matlab-source/most/md_init.m | 1 + docs/sphinx/source/matlab-source/most/most.m | 1 + .../source/matlab-source/most/most_ex1_ed.m | 1 + .../matlab-source/most/most_ex2_dcopf.m | 1 + .../matlab-source/most/most_ex3_dcopf_w_uc.m | 1 + .../matlab-source/most/most_ex4_dcopf_ss.m | 1 + .../matlab-source/most/most_ex5_mpopf.m | 1 + .../source/matlab-source/most/most_ex6_uc.m | 1 + .../source/matlab-source/most/most_ex7_suc.m | 1 + .../source/matlab-source/most/most_summary.m | 1 + .../source/matlab-source/most/mostver.m | 1 + .../matlab-source/most/mpoption_info_most.m | 1 + .../source/matlab-source/most/plot_gen.m | 1 + .../source/matlab-source/most/plot_storage.m | 1 + .../source/matlab-source/most/plot_uc.m | 1 + .../source/matlab-source/most/plot_uc_data.m | 1 + .../source/matlab-source/most/t_case30_most.m | 1 + .../source/matlab-source/most/t_case3_most.m | 1 + .../source/matlab-source/most/t_case_tlmp.m | 1 + .../matlab-source/most/t_case_tlmp_storage.m | 1 + .../matlab-source/most/t_most_30b_1_1_0.m | 1 + .../matlab-source/most/t_most_30b_1_1_0_uc.m | 1 + .../matlab-source/most/t_most_30b_1_1_17.m | 1 + .../matlab-source/most/t_most_30b_3_1_0.m | 1 + .../matlab-source/most/t_most_30b_3_1_17.m | 1 + .../matlab-source/most/t_most_3b_1_1_0.m | 1 + .../matlab-source/most/t_most_3b_1_1_2.m | 1 + .../matlab-source/most/t_most_3b_3_1_0.m | 1 + .../matlab-source/most/t_most_3b_3_1_2.m | 1 + .../matlab-source/most/t_most_fixed_res.m | 1 + .../source/matlab-source/most/t_most_mpopf.m | 1 + .../source/matlab-source/most/t_most_sp.m | 1 + .../source/matlab-source/most/t_most_spuc.m | 1 + .../source/matlab-source/most/t_most_suc.m | 1 + .../source/matlab-source/most/t_most_tlmp.m | 1 + .../source/matlab-source/most/t_most_uc.m | 1 + .../source/matlab-source/most/t_most_w_ds.m | 1 + .../source/matlab-source/most/test_most.m | 1 + .../matlab-source/most/uniformwindprofile.m | 1 + docs/sphinx/source/reference.rst | 130 ++++++++++++++++++ docs/src/MOST-manual/MOST-manual.tex | 5 + lib/addgen2mpc.m | 5 +- lib/addstorage.m | 7 +- lib/addwind.m | 7 +- lib/apply_profile.m | 5 +- lib/filter_ramp_transitions.m | 6 +- lib/getprofiles.m | 7 +- lib/idx_profile.m | 7 +- lib/loadgenericdata.m | 5 +- lib/loadmd.m | 102 ++++++++------ lib/loadstoragedata.m | 5 +- lib/loadxgendata.m | 5 +- lib/md_init.m | 6 +- lib/most.m | 113 +++++++-------- lib/most_summary.m | 64 +++++---- lib/mostver.m | 25 ++-- lib/mpoption_info_most.m | 7 +- lib/plot_gen.m | 5 +- lib/plot_storage.m | 5 +- lib/plot_uc.m | 5 +- lib/plot_uc_data.m | 5 +- lib/t/c118swf.m | 8 +- lib/t/ex_case3a.m | 7 +- lib/t/ex_case3b.m | 17 ++- lib/t/ex_contab.m | 4 +- lib/t/ex_load_profile.m | 4 +- lib/t/ex_storage.m | 4 +- lib/t/ex_transmat.m | 4 +- lib/t/ex_wind.m | 4 +- lib/t/ex_wind_profile.m | 4 +- lib/t/ex_wind_profile_d.m | 4 +- lib/t/ex_wind_uc.m | 4 +- lib/t/ex_xgd.m | 4 +- lib/t/ex_xgd_ramp.m | 4 +- lib/t/ex_xgd_res.m | 4 +- lib/t/ex_xgd_uc.m | 4 +- lib/t/generate_most_autodoc.m | 115 ++++++++++++++++ lib/t/most_ex1_ed.m | 4 +- lib/t/most_ex2_dcopf.m | 4 +- lib/t/most_ex3_dcopf_w_uc.m | 4 +- lib/t/most_ex4_dcopf_ss.m | 4 +- lib/t/most_ex5_mpopf.m | 4 +- lib/t/most_ex6_uc.m | 4 +- lib/t/most_ex7_suc.m | 4 +- lib/t/t_case30_most.m | 6 +- lib/t/t_case3_most.m | 7 +- lib/t/t_case_tlmp.m | 7 +- lib/t/t_case_tlmp_storage.m | 7 +- lib/t/t_most_30b_1_1_0.m | 4 +- lib/t/t_most_30b_1_1_0_uc.m | 4 +- lib/t/t_most_30b_1_1_17.m | 4 +- lib/t/t_most_30b_3_1_0.m | 4 +- lib/t/t_most_30b_3_1_17.m | 4 +- lib/t/t_most_3b_1_1_0.m | 4 +- lib/t/t_most_3b_1_1_2.m | 4 +- lib/t/t_most_3b_3_1_0.m | 4 +- lib/t/t_most_3b_3_1_2.m | 4 +- lib/t/t_most_fixed_res.m | 4 +- lib/t/t_most_mpopf.m | 6 +- lib/t/t_most_sp.m | 5 +- lib/t/t_most_spuc.m | 5 +- lib/t/t_most_suc.m | 5 +- lib/t/t_most_tlmp.m | 4 +- lib/t/t_most_uc.m | 5 +- lib/t/t_most_w_ds.m | 4 +- lib/t/test_most.m | 24 ++-- lib/t/uniformwindprofile.m | 7 +- 201 files changed, 1241 insertions(+), 291 deletions(-) create mode 100644 docs/sphinx/source/functions/addgen2mpc.rst create mode 100644 docs/sphinx/source/functions/addstorage.rst create mode 100644 docs/sphinx/source/functions/addwind.rst create mode 100644 docs/sphinx/source/functions/apply_profile.rst create mode 100644 docs/sphinx/source/functions/c118swf.rst create mode 100644 docs/sphinx/source/functions/ex_case3a.rst create mode 100644 docs/sphinx/source/functions/ex_case3b.rst create mode 100644 docs/sphinx/source/functions/ex_contab.rst create mode 100644 docs/sphinx/source/functions/ex_load_profile.rst create mode 100644 docs/sphinx/source/functions/ex_storage.rst create mode 100644 docs/sphinx/source/functions/ex_transmat.rst create mode 100644 docs/sphinx/source/functions/ex_wind.rst create mode 100644 docs/sphinx/source/functions/ex_wind_profile.rst create mode 100644 docs/sphinx/source/functions/ex_wind_profile_d.rst create mode 100644 docs/sphinx/source/functions/ex_wind_uc.rst create mode 100644 docs/sphinx/source/functions/ex_xgd.rst create mode 100644 docs/sphinx/source/functions/ex_xgd_ramp.rst create mode 100644 docs/sphinx/source/functions/ex_xgd_res.rst create mode 100644 docs/sphinx/source/functions/ex_xgd_uc.rst create mode 100644 docs/sphinx/source/functions/filter_ramp_transitions.rst create mode 100644 docs/sphinx/source/functions/getprofiles.rst create mode 100644 docs/sphinx/source/functions/idx_profile.rst create mode 100644 docs/sphinx/source/functions/loadgenericdata.rst create mode 100644 docs/sphinx/source/functions/loadmd.rst create mode 100644 docs/sphinx/source/functions/loadstoragedata.rst create mode 100644 docs/sphinx/source/functions/loadxgendata.rst create mode 100644 docs/sphinx/source/functions/md_init.rst create mode 100644 docs/sphinx/source/functions/most.rst create mode 100644 docs/sphinx/source/functions/most_ex1_ed.rst create mode 100644 docs/sphinx/source/functions/most_ex2_dcopf.rst create mode 100644 docs/sphinx/source/functions/most_ex3_dcopf_w_uc.rst create mode 100644 docs/sphinx/source/functions/most_ex4_dcopf_ss.rst create mode 100644 docs/sphinx/source/functions/most_ex5_mpopf.rst create mode 100644 docs/sphinx/source/functions/most_ex6_uc.rst create mode 100644 docs/sphinx/source/functions/most_ex7_suc.rst create mode 100644 docs/sphinx/source/functions/most_summary.rst create mode 100644 docs/sphinx/source/functions/mostver.rst create mode 100644 docs/sphinx/source/functions/mpoption_info_most.rst create mode 100644 docs/sphinx/source/functions/plot_gen.rst create mode 100644 docs/sphinx/source/functions/plot_storage.rst create mode 100644 docs/sphinx/source/functions/plot_uc.rst create mode 100644 docs/sphinx/source/functions/plot_uc_data.rst create mode 100644 docs/sphinx/source/functions/t_case30_most.rst create mode 100644 docs/sphinx/source/functions/t_case3_most.rst create mode 100644 docs/sphinx/source/functions/t_case_tlmp.rst create mode 100644 docs/sphinx/source/functions/t_case_tlmp_storage.rst create mode 100644 docs/sphinx/source/functions/t_most_30b_1_1_0.rst create mode 100644 docs/sphinx/source/functions/t_most_30b_1_1_0_uc.rst create mode 100644 docs/sphinx/source/functions/t_most_30b_1_1_17.rst create mode 100644 docs/sphinx/source/functions/t_most_30b_3_1_0.rst create mode 100644 docs/sphinx/source/functions/t_most_30b_3_1_17.rst create mode 100644 docs/sphinx/source/functions/t_most_3b_1_1_0.rst create mode 100644 docs/sphinx/source/functions/t_most_3b_1_1_2.rst create mode 100644 docs/sphinx/source/functions/t_most_3b_3_1_0.rst create mode 100644 docs/sphinx/source/functions/t_most_3b_3_1_2.rst create mode 100644 docs/sphinx/source/functions/t_most_fixed_res.rst create mode 100644 docs/sphinx/source/functions/t_most_mpopf.rst create mode 100644 docs/sphinx/source/functions/t_most_sp.rst create mode 100644 docs/sphinx/source/functions/t_most_spuc.rst create mode 100644 docs/sphinx/source/functions/t_most_suc.rst create mode 100644 docs/sphinx/source/functions/t_most_tlmp.rst create mode 100644 docs/sphinx/source/functions/t_most_uc.rst create mode 100644 docs/sphinx/source/functions/t_most_w_ds.rst create mode 100644 docs/sphinx/source/functions/test_most.rst create mode 100644 docs/sphinx/source/functions/uniformwindprofile.rst create mode 120000 docs/sphinx/source/matlab-source/most/addgen2mpc.m create mode 120000 docs/sphinx/source/matlab-source/most/addstorage.m create mode 120000 docs/sphinx/source/matlab-source/most/addwind.m create mode 120000 docs/sphinx/source/matlab-source/most/apply_profile.m create mode 120000 docs/sphinx/source/matlab-source/most/c118swf.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_case3a.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_case3b.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_contab.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_load_profile.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_storage.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_transmat.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_wind.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_wind_profile.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_wind_profile_d.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_wind_uc.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_xgd.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_xgd_ramp.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_xgd_res.m create mode 120000 docs/sphinx/source/matlab-source/most/ex_xgd_uc.m create mode 120000 docs/sphinx/source/matlab-source/most/filter_ramp_transitions.m create mode 120000 docs/sphinx/source/matlab-source/most/getprofiles.m create mode 120000 docs/sphinx/source/matlab-source/most/idx_profile.m create mode 120000 docs/sphinx/source/matlab-source/most/loadgenericdata.m create mode 120000 docs/sphinx/source/matlab-source/most/loadmd.m create mode 120000 docs/sphinx/source/matlab-source/most/loadstoragedata.m create mode 120000 docs/sphinx/source/matlab-source/most/loadxgendata.m create mode 120000 docs/sphinx/source/matlab-source/most/md_init.m create mode 120000 docs/sphinx/source/matlab-source/most/most.m create mode 120000 docs/sphinx/source/matlab-source/most/most_ex1_ed.m create mode 120000 docs/sphinx/source/matlab-source/most/most_ex2_dcopf.m create mode 120000 docs/sphinx/source/matlab-source/most/most_ex3_dcopf_w_uc.m create mode 120000 docs/sphinx/source/matlab-source/most/most_ex4_dcopf_ss.m create mode 120000 docs/sphinx/source/matlab-source/most/most_ex5_mpopf.m create mode 120000 docs/sphinx/source/matlab-source/most/most_ex6_uc.m create mode 120000 docs/sphinx/source/matlab-source/most/most_ex7_suc.m create mode 120000 docs/sphinx/source/matlab-source/most/most_summary.m create mode 120000 docs/sphinx/source/matlab-source/most/mostver.m create mode 120000 docs/sphinx/source/matlab-source/most/mpoption_info_most.m create mode 120000 docs/sphinx/source/matlab-source/most/plot_gen.m create mode 120000 docs/sphinx/source/matlab-source/most/plot_storage.m create mode 120000 docs/sphinx/source/matlab-source/most/plot_uc.m create mode 120000 docs/sphinx/source/matlab-source/most/plot_uc_data.m create mode 120000 docs/sphinx/source/matlab-source/most/t_case30_most.m create mode 120000 docs/sphinx/source/matlab-source/most/t_case3_most.m create mode 120000 docs/sphinx/source/matlab-source/most/t_case_tlmp.m create mode 120000 docs/sphinx/source/matlab-source/most/t_case_tlmp_storage.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_30b_1_1_0.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_30b_1_1_0_uc.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_30b_1_1_17.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_30b_3_1_0.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_30b_3_1_17.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_3b_1_1_0.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_3b_1_1_2.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_3b_3_1_0.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_3b_3_1_2.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_fixed_res.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_mpopf.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_sp.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_spuc.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_suc.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_tlmp.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_uc.m create mode 120000 docs/sphinx/source/matlab-source/most/t_most_w_ds.m create mode 120000 docs/sphinx/source/matlab-source/most/test_most.m create mode 120000 docs/sphinx/source/matlab-source/most/uniformwindprofile.m create mode 100644 docs/sphinx/source/reference.rst create mode 100644 lib/t/generate_most_autodoc.m diff --git a/CHANGES.md b/CHANGES.md index 74ca88b..5a16d56 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -5,6 +5,9 @@ Change history for MOST since 1.2 --------- +#### 3/21/24 + - Add Sphinx-based Reference documentation. + #### 11/8/23 - Speed up building unit commitment (min up/down time) constraints. Improvement can be quite substantial on large problems. diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index be2b8a7..9f5acae 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -1,6 +1,7 @@ # Configuration file for the Sphinx documentation builder. # -# For the full list of built-in configuration values, see the documentation: +# This file only contains a selection of the most common options. For a full +# list see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html # -- Path setup -------------------------------------------------------------- @@ -20,19 +21,26 @@ # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information project = 'MOST' -copyright = '2011-2022, Power Systems Engineering Research Center (PSERC)' +copyright = '2011-2024, Power Systems Engineering Research Center (PSERC)' author = 'Ray D. Zimmerman, Carlos E. Murillo-Sánchez' -release = '1.2' + +# The full version, including alpha/beta/rc tags +release = '1.3+' + # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration extensions = [ 'sphinxcontrib.matlab', + 'sphinx.ext.autodoc', 'sphinx.ext.extlinks', + 'sphinx.ext.napoleon', 'sphinx_rtd_theme', 'sphinx_tabs.tabs', ] +this_dir = os.path.dirname(os.path.abspath(__file__)) +matlab_src_dir = os.path.abspath(os.path.join(this_dir, 'matlab-source')) primary_domain = 'mat' templates_path = ['_templates'] @@ -63,6 +71,21 @@ # -- Other Options ----------------------------------------------------------- +matlab_short_links = True +# matlab_auto_link = "basic" +matlab_auto_link = "all" +matlab_show_property_default_value = True +# autoclass_content = 'both' # 'class', 'init', 'both' +autodoc_member_order = 'bysource' # 'alphabetical', 'groupwise', 'bysource' +napoleon_use_param = False +napoleon_use_rtype = False +napoleon_custom_sections = [ + ('Input', 'params_style'), + ('Inputs', 'params_style'), + ('Output', 'params_style'), + ('Outputs', 'params_style'), +] + rst_prolog = """ .. include:: /mp-docs-shared/prolog.rst.txt """ @@ -76,7 +99,8 @@ 'figure': 'Figure %s', 'code-block': 'Listing %s', 'section': 'Section %s' } -highlight_language = 'matlab' +highlight_language = 'octave' # 'matlab' has issues with '...' + # e.g. y = fcn(x, ...) math_number_all = True math_eqref_format = '({number})' @@ -91,9 +115,9 @@ with open('mp-docs-shared/mathCmds.tex.txt', 'r') as f: for line in f: - macros = re.findall(r'\\newcommand{\\(.*?)}(\[(\d)\])?{(.+)}', line) + macros = re.findall(r'\\(re)?newcommand{\\(.*?)}(\[(\d)\])?{(.+)}', line) for macro in macros: - if len(macro[1]) == 0: - mathjax3_config['tex']['macros'][macro[0]] = "{"+macro[3]+"}" + if len(macro[2]) == 0: + mathjax3_config['tex']['macros'][macro[1]] = macro[4] else: - mathjax3_config['tex']['macros'][macro[0]] = ["{"+macro[3]+"}", int(macro[2])] + mathjax3_config['tex']['macros'][macro[1]] = [macro[4], int(macro[3])] diff --git a/docs/sphinx/source/functions/addgen2mpc.rst b/docs/sphinx/source/functions/addgen2mpc.rst new file mode 100644 index 0000000..c8d59d9 --- /dev/null +++ b/docs/sphinx/source/functions/addgen2mpc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +addgen2mpc +---------- + +.. autofunction:: addgen2mpc diff --git a/docs/sphinx/source/functions/addstorage.rst b/docs/sphinx/source/functions/addstorage.rst new file mode 100644 index 0000000..155a182 --- /dev/null +++ b/docs/sphinx/source/functions/addstorage.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +addstorage +---------- + +.. autofunction:: addstorage diff --git a/docs/sphinx/source/functions/addwind.rst b/docs/sphinx/source/functions/addwind.rst new file mode 100644 index 0000000..b97101f --- /dev/null +++ b/docs/sphinx/source/functions/addwind.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +addwind +------- + +.. autofunction:: addwind diff --git a/docs/sphinx/source/functions/apply_profile.rst b/docs/sphinx/source/functions/apply_profile.rst new file mode 100644 index 0000000..c146278 --- /dev/null +++ b/docs/sphinx/source/functions/apply_profile.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +apply_profile +------------- + +.. autofunction:: apply_profile diff --git a/docs/sphinx/source/functions/c118swf.rst b/docs/sphinx/source/functions/c118swf.rst new file mode 100644 index 0000000..0765abc --- /dev/null +++ b/docs/sphinx/source/functions/c118swf.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +c118swf +------- + +.. autofunction:: c118swf diff --git a/docs/sphinx/source/functions/ex_case3a.rst b/docs/sphinx/source/functions/ex_case3a.rst new file mode 100644 index 0000000..4f587ae --- /dev/null +++ b/docs/sphinx/source/functions/ex_case3a.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_case3a +--------- + +.. autofunction:: ex_case3a diff --git a/docs/sphinx/source/functions/ex_case3b.rst b/docs/sphinx/source/functions/ex_case3b.rst new file mode 100644 index 0000000..758e428 --- /dev/null +++ b/docs/sphinx/source/functions/ex_case3b.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_case3b +--------- + +.. autofunction:: ex_case3b diff --git a/docs/sphinx/source/functions/ex_contab.rst b/docs/sphinx/source/functions/ex_contab.rst new file mode 100644 index 0000000..0a64775 --- /dev/null +++ b/docs/sphinx/source/functions/ex_contab.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_contab +--------- + +.. autofunction:: ex_contab diff --git a/docs/sphinx/source/functions/ex_load_profile.rst b/docs/sphinx/source/functions/ex_load_profile.rst new file mode 100644 index 0000000..22cda11 --- /dev/null +++ b/docs/sphinx/source/functions/ex_load_profile.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_load_profile +--------------- + +.. autofunction:: ex_load_profile diff --git a/docs/sphinx/source/functions/ex_storage.rst b/docs/sphinx/source/functions/ex_storage.rst new file mode 100644 index 0000000..a779591 --- /dev/null +++ b/docs/sphinx/source/functions/ex_storage.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_storage +---------- + +.. autofunction:: ex_storage diff --git a/docs/sphinx/source/functions/ex_transmat.rst b/docs/sphinx/source/functions/ex_transmat.rst new file mode 100644 index 0000000..34961dc --- /dev/null +++ b/docs/sphinx/source/functions/ex_transmat.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_transmat +----------- + +.. autofunction:: ex_transmat diff --git a/docs/sphinx/source/functions/ex_wind.rst b/docs/sphinx/source/functions/ex_wind.rst new file mode 100644 index 0000000..66e85a8 --- /dev/null +++ b/docs/sphinx/source/functions/ex_wind.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_wind +------- + +.. autofunction:: ex_wind diff --git a/docs/sphinx/source/functions/ex_wind_profile.rst b/docs/sphinx/source/functions/ex_wind_profile.rst new file mode 100644 index 0000000..bc5173b --- /dev/null +++ b/docs/sphinx/source/functions/ex_wind_profile.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_wind_profile +--------------- + +.. autofunction:: ex_wind_profile diff --git a/docs/sphinx/source/functions/ex_wind_profile_d.rst b/docs/sphinx/source/functions/ex_wind_profile_d.rst new file mode 100644 index 0000000..25d1f03 --- /dev/null +++ b/docs/sphinx/source/functions/ex_wind_profile_d.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_wind_profile_d +----------------- + +.. autofunction:: ex_wind_profile_d diff --git a/docs/sphinx/source/functions/ex_wind_uc.rst b/docs/sphinx/source/functions/ex_wind_uc.rst new file mode 100644 index 0000000..358d696 --- /dev/null +++ b/docs/sphinx/source/functions/ex_wind_uc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_wind_uc +---------- + +.. autofunction:: ex_wind_uc diff --git a/docs/sphinx/source/functions/ex_xgd.rst b/docs/sphinx/source/functions/ex_xgd.rst new file mode 100644 index 0000000..ae72104 --- /dev/null +++ b/docs/sphinx/source/functions/ex_xgd.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_xgd +------ + +.. autofunction:: ex_xgd diff --git a/docs/sphinx/source/functions/ex_xgd_ramp.rst b/docs/sphinx/source/functions/ex_xgd_ramp.rst new file mode 100644 index 0000000..b8ce51b --- /dev/null +++ b/docs/sphinx/source/functions/ex_xgd_ramp.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_xgd_ramp +----------- + +.. autofunction:: ex_xgd_ramp diff --git a/docs/sphinx/source/functions/ex_xgd_res.rst b/docs/sphinx/source/functions/ex_xgd_res.rst new file mode 100644 index 0000000..605d86c --- /dev/null +++ b/docs/sphinx/source/functions/ex_xgd_res.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_xgd_res +---------- + +.. autofunction:: ex_xgd_res diff --git a/docs/sphinx/source/functions/ex_xgd_uc.rst b/docs/sphinx/source/functions/ex_xgd_uc.rst new file mode 100644 index 0000000..ec6c240 --- /dev/null +++ b/docs/sphinx/source/functions/ex_xgd_uc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +ex_xgd_uc +--------- + +.. autofunction:: ex_xgd_uc diff --git a/docs/sphinx/source/functions/filter_ramp_transitions.rst b/docs/sphinx/source/functions/filter_ramp_transitions.rst new file mode 100644 index 0000000..ec8ceef --- /dev/null +++ b/docs/sphinx/source/functions/filter_ramp_transitions.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +filter_ramp_transitions +----------------------- + +.. autofunction:: filter_ramp_transitions diff --git a/docs/sphinx/source/functions/getprofiles.rst b/docs/sphinx/source/functions/getprofiles.rst new file mode 100644 index 0000000..0fe3973 --- /dev/null +++ b/docs/sphinx/source/functions/getprofiles.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +getprofiles +----------- + +.. autofunction:: getprofiles diff --git a/docs/sphinx/source/functions/idx_profile.rst b/docs/sphinx/source/functions/idx_profile.rst new file mode 100644 index 0000000..05aeb89 --- /dev/null +++ b/docs/sphinx/source/functions/idx_profile.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +idx_profile +----------- + +.. autofunction:: idx_profile diff --git a/docs/sphinx/source/functions/loadgenericdata.rst b/docs/sphinx/source/functions/loadgenericdata.rst new file mode 100644 index 0000000..84da0b5 --- /dev/null +++ b/docs/sphinx/source/functions/loadgenericdata.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +loadgenericdata +--------------- + +.. autofunction:: loadgenericdata diff --git a/docs/sphinx/source/functions/loadmd.rst b/docs/sphinx/source/functions/loadmd.rst new file mode 100644 index 0000000..3c01c8c --- /dev/null +++ b/docs/sphinx/source/functions/loadmd.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +loadmd +------ + +.. autofunction:: loadmd diff --git a/docs/sphinx/source/functions/loadstoragedata.rst b/docs/sphinx/source/functions/loadstoragedata.rst new file mode 100644 index 0000000..8047908 --- /dev/null +++ b/docs/sphinx/source/functions/loadstoragedata.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +loadstoragedata +--------------- + +.. autofunction:: loadstoragedata diff --git a/docs/sphinx/source/functions/loadxgendata.rst b/docs/sphinx/source/functions/loadxgendata.rst new file mode 100644 index 0000000..808dc80 --- /dev/null +++ b/docs/sphinx/source/functions/loadxgendata.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +loadxgendata +------------ + +.. autofunction:: loadxgendata diff --git a/docs/sphinx/source/functions/md_init.rst b/docs/sphinx/source/functions/md_init.rst new file mode 100644 index 0000000..0f795fc --- /dev/null +++ b/docs/sphinx/source/functions/md_init.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +md_init +------- + +.. autofunction:: md_init diff --git a/docs/sphinx/source/functions/most.rst b/docs/sphinx/source/functions/most.rst new file mode 100644 index 0000000..205b7ab --- /dev/null +++ b/docs/sphinx/source/functions/most.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +most +---- + +.. autofunction:: most diff --git a/docs/sphinx/source/functions/most_ex1_ed.rst b/docs/sphinx/source/functions/most_ex1_ed.rst new file mode 100644 index 0000000..0919db7 --- /dev/null +++ b/docs/sphinx/source/functions/most_ex1_ed.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +most_ex1_ed +----------- + +.. autofunction:: most_ex1_ed diff --git a/docs/sphinx/source/functions/most_ex2_dcopf.rst b/docs/sphinx/source/functions/most_ex2_dcopf.rst new file mode 100644 index 0000000..d7d0f4b --- /dev/null +++ b/docs/sphinx/source/functions/most_ex2_dcopf.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +most_ex2_dcopf +-------------- + +.. autofunction:: most_ex2_dcopf diff --git a/docs/sphinx/source/functions/most_ex3_dcopf_w_uc.rst b/docs/sphinx/source/functions/most_ex3_dcopf_w_uc.rst new file mode 100644 index 0000000..bd8bf53 --- /dev/null +++ b/docs/sphinx/source/functions/most_ex3_dcopf_w_uc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +most_ex3_dcopf_w_uc +------------------- + +.. autofunction:: most_ex3_dcopf_w_uc diff --git a/docs/sphinx/source/functions/most_ex4_dcopf_ss.rst b/docs/sphinx/source/functions/most_ex4_dcopf_ss.rst new file mode 100644 index 0000000..734f8d1 --- /dev/null +++ b/docs/sphinx/source/functions/most_ex4_dcopf_ss.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +most_ex4_dcopf_ss +----------------- + +.. autofunction:: most_ex4_dcopf_ss diff --git a/docs/sphinx/source/functions/most_ex5_mpopf.rst b/docs/sphinx/source/functions/most_ex5_mpopf.rst new file mode 100644 index 0000000..c7ab110 --- /dev/null +++ b/docs/sphinx/source/functions/most_ex5_mpopf.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +most_ex5_mpopf +-------------- + +.. autofunction:: most_ex5_mpopf diff --git a/docs/sphinx/source/functions/most_ex6_uc.rst b/docs/sphinx/source/functions/most_ex6_uc.rst new file mode 100644 index 0000000..24a4199 --- /dev/null +++ b/docs/sphinx/source/functions/most_ex6_uc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +most_ex6_uc +----------- + +.. autofunction:: most_ex6_uc diff --git a/docs/sphinx/source/functions/most_ex7_suc.rst b/docs/sphinx/source/functions/most_ex7_suc.rst new file mode 100644 index 0000000..6c2672e --- /dev/null +++ b/docs/sphinx/source/functions/most_ex7_suc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +most_ex7_suc +------------ + +.. autofunction:: most_ex7_suc diff --git a/docs/sphinx/source/functions/most_summary.rst b/docs/sphinx/source/functions/most_summary.rst new file mode 100644 index 0000000..cb3eef7 --- /dev/null +++ b/docs/sphinx/source/functions/most_summary.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +most_summary +------------ + +.. autofunction:: most_summary diff --git a/docs/sphinx/source/functions/mostver.rst b/docs/sphinx/source/functions/mostver.rst new file mode 100644 index 0000000..e462d5f --- /dev/null +++ b/docs/sphinx/source/functions/mostver.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +mostver +------- + +.. autofunction:: mostver diff --git a/docs/sphinx/source/functions/mpoption_info_most.rst b/docs/sphinx/source/functions/mpoption_info_most.rst new file mode 100644 index 0000000..689e004 --- /dev/null +++ b/docs/sphinx/source/functions/mpoption_info_most.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +mpoption_info_most +------------------ + +.. autofunction:: mpoption_info_most diff --git a/docs/sphinx/source/functions/plot_gen.rst b/docs/sphinx/source/functions/plot_gen.rst new file mode 100644 index 0000000..34f0a53 --- /dev/null +++ b/docs/sphinx/source/functions/plot_gen.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +plot_gen +-------- + +.. autofunction:: plot_gen diff --git a/docs/sphinx/source/functions/plot_storage.rst b/docs/sphinx/source/functions/plot_storage.rst new file mode 100644 index 0000000..7080d75 --- /dev/null +++ b/docs/sphinx/source/functions/plot_storage.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +plot_storage +------------ + +.. autofunction:: plot_storage diff --git a/docs/sphinx/source/functions/plot_uc.rst b/docs/sphinx/source/functions/plot_uc.rst new file mode 100644 index 0000000..562bf07 --- /dev/null +++ b/docs/sphinx/source/functions/plot_uc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +plot_uc +------- + +.. autofunction:: plot_uc diff --git a/docs/sphinx/source/functions/plot_uc_data.rst b/docs/sphinx/source/functions/plot_uc_data.rst new file mode 100644 index 0000000..83ce2f4 --- /dev/null +++ b/docs/sphinx/source/functions/plot_uc_data.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +plot_uc_data +------------ + +.. autofunction:: plot_uc_data diff --git a/docs/sphinx/source/functions/t_case30_most.rst b/docs/sphinx/source/functions/t_case30_most.rst new file mode 100644 index 0000000..d6ae566 --- /dev/null +++ b/docs/sphinx/source/functions/t_case30_most.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_case30_most +------------- + +.. autofunction:: t_case30_most diff --git a/docs/sphinx/source/functions/t_case3_most.rst b/docs/sphinx/source/functions/t_case3_most.rst new file mode 100644 index 0000000..dbbc726 --- /dev/null +++ b/docs/sphinx/source/functions/t_case3_most.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_case3_most +------------ + +.. autofunction:: t_case3_most diff --git a/docs/sphinx/source/functions/t_case_tlmp.rst b/docs/sphinx/source/functions/t_case_tlmp.rst new file mode 100644 index 0000000..1ff0ca8 --- /dev/null +++ b/docs/sphinx/source/functions/t_case_tlmp.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_case_tlmp +----------- + +.. autofunction:: t_case_tlmp diff --git a/docs/sphinx/source/functions/t_case_tlmp_storage.rst b/docs/sphinx/source/functions/t_case_tlmp_storage.rst new file mode 100644 index 0000000..3eea720 --- /dev/null +++ b/docs/sphinx/source/functions/t_case_tlmp_storage.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_case_tlmp_storage +------------------- + +.. autofunction:: t_case_tlmp_storage diff --git a/docs/sphinx/source/functions/t_most_30b_1_1_0.rst b/docs/sphinx/source/functions/t_most_30b_1_1_0.rst new file mode 100644 index 0000000..2766282 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_30b_1_1_0.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_30b_1_1_0 +---------------- + +.. autofunction:: t_most_30b_1_1_0 diff --git a/docs/sphinx/source/functions/t_most_30b_1_1_0_uc.rst b/docs/sphinx/source/functions/t_most_30b_1_1_0_uc.rst new file mode 100644 index 0000000..97c148f --- /dev/null +++ b/docs/sphinx/source/functions/t_most_30b_1_1_0_uc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_30b_1_1_0_uc +------------------- + +.. autofunction:: t_most_30b_1_1_0_uc diff --git a/docs/sphinx/source/functions/t_most_30b_1_1_17.rst b/docs/sphinx/source/functions/t_most_30b_1_1_17.rst new file mode 100644 index 0000000..5504d90 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_30b_1_1_17.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_30b_1_1_17 +----------------- + +.. autofunction:: t_most_30b_1_1_17 diff --git a/docs/sphinx/source/functions/t_most_30b_3_1_0.rst b/docs/sphinx/source/functions/t_most_30b_3_1_0.rst new file mode 100644 index 0000000..b7e4f95 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_30b_3_1_0.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_30b_3_1_0 +---------------- + +.. autofunction:: t_most_30b_3_1_0 diff --git a/docs/sphinx/source/functions/t_most_30b_3_1_17.rst b/docs/sphinx/source/functions/t_most_30b_3_1_17.rst new file mode 100644 index 0000000..2204ef2 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_30b_3_1_17.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_30b_3_1_17 +----------------- + +.. autofunction:: t_most_30b_3_1_17 diff --git a/docs/sphinx/source/functions/t_most_3b_1_1_0.rst b/docs/sphinx/source/functions/t_most_3b_1_1_0.rst new file mode 100644 index 0000000..9a6aa8f --- /dev/null +++ b/docs/sphinx/source/functions/t_most_3b_1_1_0.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_3b_1_1_0 +--------------- + +.. autofunction:: t_most_3b_1_1_0 diff --git a/docs/sphinx/source/functions/t_most_3b_1_1_2.rst b/docs/sphinx/source/functions/t_most_3b_1_1_2.rst new file mode 100644 index 0000000..11ed705 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_3b_1_1_2.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_3b_1_1_2 +--------------- + +.. autofunction:: t_most_3b_1_1_2 diff --git a/docs/sphinx/source/functions/t_most_3b_3_1_0.rst b/docs/sphinx/source/functions/t_most_3b_3_1_0.rst new file mode 100644 index 0000000..849bf26 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_3b_3_1_0.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_3b_3_1_0 +--------------- + +.. autofunction:: t_most_3b_3_1_0 diff --git a/docs/sphinx/source/functions/t_most_3b_3_1_2.rst b/docs/sphinx/source/functions/t_most_3b_3_1_2.rst new file mode 100644 index 0000000..6955bb9 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_3b_3_1_2.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_3b_3_1_2 +--------------- + +.. autofunction:: t_most_3b_3_1_2 diff --git a/docs/sphinx/source/functions/t_most_fixed_res.rst b/docs/sphinx/source/functions/t_most_fixed_res.rst new file mode 100644 index 0000000..96f9ce1 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_fixed_res.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_fixed_res +---------------- + +.. autofunction:: t_most_fixed_res diff --git a/docs/sphinx/source/functions/t_most_mpopf.rst b/docs/sphinx/source/functions/t_most_mpopf.rst new file mode 100644 index 0000000..4db8c9f --- /dev/null +++ b/docs/sphinx/source/functions/t_most_mpopf.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_mpopf +------------ + +.. autofunction:: t_most_mpopf diff --git a/docs/sphinx/source/functions/t_most_sp.rst b/docs/sphinx/source/functions/t_most_sp.rst new file mode 100644 index 0000000..034a59c --- /dev/null +++ b/docs/sphinx/source/functions/t_most_sp.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_sp +--------- + +.. autofunction:: t_most_sp diff --git a/docs/sphinx/source/functions/t_most_spuc.rst b/docs/sphinx/source/functions/t_most_spuc.rst new file mode 100644 index 0000000..eb8fea7 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_spuc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_spuc +----------- + +.. autofunction:: t_most_spuc diff --git a/docs/sphinx/source/functions/t_most_suc.rst b/docs/sphinx/source/functions/t_most_suc.rst new file mode 100644 index 0000000..60fc037 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_suc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_suc +---------- + +.. autofunction:: t_most_suc diff --git a/docs/sphinx/source/functions/t_most_tlmp.rst b/docs/sphinx/source/functions/t_most_tlmp.rst new file mode 100644 index 0000000..b5dee5d --- /dev/null +++ b/docs/sphinx/source/functions/t_most_tlmp.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_tlmp +----------- + +.. autofunction:: t_most_tlmp diff --git a/docs/sphinx/source/functions/t_most_uc.rst b/docs/sphinx/source/functions/t_most_uc.rst new file mode 100644 index 0000000..2cf2a2c --- /dev/null +++ b/docs/sphinx/source/functions/t_most_uc.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_uc +--------- + +.. autofunction:: t_most_uc diff --git a/docs/sphinx/source/functions/t_most_w_ds.rst b/docs/sphinx/source/functions/t_most_w_ds.rst new file mode 100644 index 0000000..80e80c4 --- /dev/null +++ b/docs/sphinx/source/functions/t_most_w_ds.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +t_most_w_ds +----------- + +.. autofunction:: t_most_w_ds diff --git a/docs/sphinx/source/functions/test_most.rst b/docs/sphinx/source/functions/test_most.rst new file mode 100644 index 0000000..b945e91 --- /dev/null +++ b/docs/sphinx/source/functions/test_most.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +test_most +--------- + +.. autofunction:: test_most diff --git a/docs/sphinx/source/functions/uniformwindprofile.rst b/docs/sphinx/source/functions/uniformwindprofile.rst new file mode 100644 index 0000000..e907f74 --- /dev/null +++ b/docs/sphinx/source/functions/uniformwindprofile.rst @@ -0,0 +1,8 @@ +.. currentmodule:: most + +:raw-html:`
` + +uniformwindprofile +------------------ + +.. autofunction:: uniformwindprofile diff --git a/docs/sphinx/source/index.rst b/docs/sphinx/source/index.rst index 43ea189..fbb6c85 100644 --- a/docs/sphinx/source/index.rst +++ b/docs/sphinx/source/index.rst @@ -1,6 +1,6 @@ -#################### -|MOST| User's Manual -#################### +################## +MOST User's Manual +################## .. toctree:: :maxdepth: 2 @@ -8,4 +8,14 @@ .. note:: - The new web-based version of the |MOST| User's Manual is not yet available. Please, continue to use the PDF version of the |MOSTman| for now. + The new web-based version of the MOST User's Manual is not yet available. Please, continue to use the PDF version of the |MOSTman| for now, along with the new reference documentation below. + + +Reference +========= + +The primary sources of documentation for MOST, aside from the legacy PDF |MOSTman|, are this :ref:`sec_most_reference` documentation and the built-in ``help`` command. As with the built-in functions and toolbox routines in |MATLAB>| and |Octave>|, you can type ``help`` followed by the name of a command or M-file to get help on that particular function. + +.. toctree:: + + reference diff --git a/docs/sphinx/source/matlab-source/most/addgen2mpc.m b/docs/sphinx/source/matlab-source/most/addgen2mpc.m new file mode 120000 index 0000000..381f8c1 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/addgen2mpc.m @@ -0,0 +1 @@ +../../../../../lib/addgen2mpc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/addstorage.m b/docs/sphinx/source/matlab-source/most/addstorage.m new file mode 120000 index 0000000..1e188d3 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/addstorage.m @@ -0,0 +1 @@ +../../../../../lib/addstorage.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/addwind.m b/docs/sphinx/source/matlab-source/most/addwind.m new file mode 120000 index 0000000..ee8e8b7 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/addwind.m @@ -0,0 +1 @@ +../../../../../lib/addwind.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/apply_profile.m b/docs/sphinx/source/matlab-source/most/apply_profile.m new file mode 120000 index 0000000..b476b8c --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/apply_profile.m @@ -0,0 +1 @@ +../../../../../lib/apply_profile.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/c118swf.m b/docs/sphinx/source/matlab-source/most/c118swf.m new file mode 120000 index 0000000..dd96b41 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/c118swf.m @@ -0,0 +1 @@ +../../../../../lib/t/c118swf.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_case3a.m b/docs/sphinx/source/matlab-source/most/ex_case3a.m new file mode 120000 index 0000000..65a419d --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_case3a.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_case3a.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_case3b.m b/docs/sphinx/source/matlab-source/most/ex_case3b.m new file mode 120000 index 0000000..4463777 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_case3b.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_case3b.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_contab.m b/docs/sphinx/source/matlab-source/most/ex_contab.m new file mode 120000 index 0000000..223a9e2 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_contab.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_contab.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_load_profile.m b/docs/sphinx/source/matlab-source/most/ex_load_profile.m new file mode 120000 index 0000000..32d3328 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_load_profile.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_load_profile.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_storage.m b/docs/sphinx/source/matlab-source/most/ex_storage.m new file mode 120000 index 0000000..9612269 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_storage.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_storage.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_transmat.m b/docs/sphinx/source/matlab-source/most/ex_transmat.m new file mode 120000 index 0000000..426d4ad --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_transmat.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_transmat.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_wind.m b/docs/sphinx/source/matlab-source/most/ex_wind.m new file mode 120000 index 0000000..2f9c54e --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_wind.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_wind.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_wind_profile.m b/docs/sphinx/source/matlab-source/most/ex_wind_profile.m new file mode 120000 index 0000000..a8b5a53 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_wind_profile.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_wind_profile.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_wind_profile_d.m b/docs/sphinx/source/matlab-source/most/ex_wind_profile_d.m new file mode 120000 index 0000000..a767ae0 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_wind_profile_d.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_wind_profile_d.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_wind_uc.m b/docs/sphinx/source/matlab-source/most/ex_wind_uc.m new file mode 120000 index 0000000..5aae376 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_wind_uc.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_wind_uc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_xgd.m b/docs/sphinx/source/matlab-source/most/ex_xgd.m new file mode 120000 index 0000000..4aa7bb8 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_xgd.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_xgd.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_xgd_ramp.m b/docs/sphinx/source/matlab-source/most/ex_xgd_ramp.m new file mode 120000 index 0000000..425162b --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_xgd_ramp.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_xgd_ramp.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_xgd_res.m b/docs/sphinx/source/matlab-source/most/ex_xgd_res.m new file mode 120000 index 0000000..77afcb1 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_xgd_res.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_xgd_res.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/ex_xgd_uc.m b/docs/sphinx/source/matlab-source/most/ex_xgd_uc.m new file mode 120000 index 0000000..864a666 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/ex_xgd_uc.m @@ -0,0 +1 @@ +../../../../../lib/t/ex_xgd_uc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/filter_ramp_transitions.m b/docs/sphinx/source/matlab-source/most/filter_ramp_transitions.m new file mode 120000 index 0000000..7155853 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/filter_ramp_transitions.m @@ -0,0 +1 @@ +../../../../../lib/filter_ramp_transitions.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/getprofiles.m b/docs/sphinx/source/matlab-source/most/getprofiles.m new file mode 120000 index 0000000..dddf209 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/getprofiles.m @@ -0,0 +1 @@ +../../../../../lib/getprofiles.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/idx_profile.m b/docs/sphinx/source/matlab-source/most/idx_profile.m new file mode 120000 index 0000000..8512642 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/idx_profile.m @@ -0,0 +1 @@ +../../../../../lib/idx_profile.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/loadgenericdata.m b/docs/sphinx/source/matlab-source/most/loadgenericdata.m new file mode 120000 index 0000000..00fedab --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/loadgenericdata.m @@ -0,0 +1 @@ +../../../../../lib/loadgenericdata.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/loadmd.m b/docs/sphinx/source/matlab-source/most/loadmd.m new file mode 120000 index 0000000..1b28d09 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/loadmd.m @@ -0,0 +1 @@ +../../../../../lib/loadmd.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/loadstoragedata.m b/docs/sphinx/source/matlab-source/most/loadstoragedata.m new file mode 120000 index 0000000..65650c3 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/loadstoragedata.m @@ -0,0 +1 @@ +../../../../../lib/loadstoragedata.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/loadxgendata.m b/docs/sphinx/source/matlab-source/most/loadxgendata.m new file mode 120000 index 0000000..0aeae5d --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/loadxgendata.m @@ -0,0 +1 @@ +../../../../../lib/loadxgendata.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/md_init.m b/docs/sphinx/source/matlab-source/most/md_init.m new file mode 120000 index 0000000..8facd31 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/md_init.m @@ -0,0 +1 @@ +../../../../../lib/md_init.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/most.m b/docs/sphinx/source/matlab-source/most/most.m new file mode 120000 index 0000000..7f0f82a --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/most.m @@ -0,0 +1 @@ +../../../../../lib/most.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/most_ex1_ed.m b/docs/sphinx/source/matlab-source/most/most_ex1_ed.m new file mode 120000 index 0000000..092fa3e --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/most_ex1_ed.m @@ -0,0 +1 @@ +../../../../../lib/t/most_ex1_ed.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/most_ex2_dcopf.m b/docs/sphinx/source/matlab-source/most/most_ex2_dcopf.m new file mode 120000 index 0000000..a8bf0f7 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/most_ex2_dcopf.m @@ -0,0 +1 @@ +../../../../../lib/t/most_ex2_dcopf.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/most_ex3_dcopf_w_uc.m b/docs/sphinx/source/matlab-source/most/most_ex3_dcopf_w_uc.m new file mode 120000 index 0000000..ecc89ce --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/most_ex3_dcopf_w_uc.m @@ -0,0 +1 @@ +../../../../../lib/t/most_ex3_dcopf_w_uc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/most_ex4_dcopf_ss.m b/docs/sphinx/source/matlab-source/most/most_ex4_dcopf_ss.m new file mode 120000 index 0000000..55cf0ed --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/most_ex4_dcopf_ss.m @@ -0,0 +1 @@ +../../../../../lib/t/most_ex4_dcopf_ss.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/most_ex5_mpopf.m b/docs/sphinx/source/matlab-source/most/most_ex5_mpopf.m new file mode 120000 index 0000000..3b01118 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/most_ex5_mpopf.m @@ -0,0 +1 @@ +../../../../../lib/t/most_ex5_mpopf.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/most_ex6_uc.m b/docs/sphinx/source/matlab-source/most/most_ex6_uc.m new file mode 120000 index 0000000..4328abc --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/most_ex6_uc.m @@ -0,0 +1 @@ +../../../../../lib/t/most_ex6_uc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/most_ex7_suc.m b/docs/sphinx/source/matlab-source/most/most_ex7_suc.m new file mode 120000 index 0000000..e74ea92 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/most_ex7_suc.m @@ -0,0 +1 @@ +../../../../../lib/t/most_ex7_suc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/most_summary.m b/docs/sphinx/source/matlab-source/most/most_summary.m new file mode 120000 index 0000000..31cbdcc --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/most_summary.m @@ -0,0 +1 @@ +../../../../../lib/most_summary.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/mostver.m b/docs/sphinx/source/matlab-source/most/mostver.m new file mode 120000 index 0000000..b1acb56 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/mostver.m @@ -0,0 +1 @@ +../../../../../lib/mostver.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/mpoption_info_most.m b/docs/sphinx/source/matlab-source/most/mpoption_info_most.m new file mode 120000 index 0000000..1722515 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/mpoption_info_most.m @@ -0,0 +1 @@ +../../../../../lib/mpoption_info_most.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/plot_gen.m b/docs/sphinx/source/matlab-source/most/plot_gen.m new file mode 120000 index 0000000..c868ca2 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/plot_gen.m @@ -0,0 +1 @@ +../../../../../lib/plot_gen.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/plot_storage.m b/docs/sphinx/source/matlab-source/most/plot_storage.m new file mode 120000 index 0000000..262a10e --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/plot_storage.m @@ -0,0 +1 @@ +../../../../../lib/plot_storage.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/plot_uc.m b/docs/sphinx/source/matlab-source/most/plot_uc.m new file mode 120000 index 0000000..ca442c7 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/plot_uc.m @@ -0,0 +1 @@ +../../../../../lib/plot_uc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/plot_uc_data.m b/docs/sphinx/source/matlab-source/most/plot_uc_data.m new file mode 120000 index 0000000..a9d5c6c --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/plot_uc_data.m @@ -0,0 +1 @@ +../../../../../lib/plot_uc_data.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_case30_most.m b/docs/sphinx/source/matlab-source/most/t_case30_most.m new file mode 120000 index 0000000..eae516d --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_case30_most.m @@ -0,0 +1 @@ +../../../../../lib/t/t_case30_most.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_case3_most.m b/docs/sphinx/source/matlab-source/most/t_case3_most.m new file mode 120000 index 0000000..6ceb02c --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_case3_most.m @@ -0,0 +1 @@ +../../../../../lib/t/t_case3_most.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_case_tlmp.m b/docs/sphinx/source/matlab-source/most/t_case_tlmp.m new file mode 120000 index 0000000..8a908f0 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_case_tlmp.m @@ -0,0 +1 @@ +../../../../../lib/t/t_case_tlmp.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_case_tlmp_storage.m b/docs/sphinx/source/matlab-source/most/t_case_tlmp_storage.m new file mode 120000 index 0000000..121c4a1 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_case_tlmp_storage.m @@ -0,0 +1 @@ +../../../../../lib/t/t_case_tlmp_storage.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_30b_1_1_0.m b/docs/sphinx/source/matlab-source/most/t_most_30b_1_1_0.m new file mode 120000 index 0000000..47ec4f7 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_30b_1_1_0.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_30b_1_1_0.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_30b_1_1_0_uc.m b/docs/sphinx/source/matlab-source/most/t_most_30b_1_1_0_uc.m new file mode 120000 index 0000000..cdfa8bf --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_30b_1_1_0_uc.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_30b_1_1_0_uc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_30b_1_1_17.m b/docs/sphinx/source/matlab-source/most/t_most_30b_1_1_17.m new file mode 120000 index 0000000..45619d7 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_30b_1_1_17.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_30b_1_1_17.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_30b_3_1_0.m b/docs/sphinx/source/matlab-source/most/t_most_30b_3_1_0.m new file mode 120000 index 0000000..721c454 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_30b_3_1_0.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_30b_3_1_0.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_30b_3_1_17.m b/docs/sphinx/source/matlab-source/most/t_most_30b_3_1_17.m new file mode 120000 index 0000000..fef7ca3 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_30b_3_1_17.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_30b_3_1_17.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_3b_1_1_0.m b/docs/sphinx/source/matlab-source/most/t_most_3b_1_1_0.m new file mode 120000 index 0000000..15e98ca --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_3b_1_1_0.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_3b_1_1_0.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_3b_1_1_2.m b/docs/sphinx/source/matlab-source/most/t_most_3b_1_1_2.m new file mode 120000 index 0000000..92bb37b --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_3b_1_1_2.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_3b_1_1_2.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_3b_3_1_0.m b/docs/sphinx/source/matlab-source/most/t_most_3b_3_1_0.m new file mode 120000 index 0000000..e847b82 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_3b_3_1_0.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_3b_3_1_0.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_3b_3_1_2.m b/docs/sphinx/source/matlab-source/most/t_most_3b_3_1_2.m new file mode 120000 index 0000000..9392f17 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_3b_3_1_2.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_3b_3_1_2.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_fixed_res.m b/docs/sphinx/source/matlab-source/most/t_most_fixed_res.m new file mode 120000 index 0000000..f96beeb --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_fixed_res.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_fixed_res.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_mpopf.m b/docs/sphinx/source/matlab-source/most/t_most_mpopf.m new file mode 120000 index 0000000..f7b6d05 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_mpopf.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_mpopf.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_sp.m b/docs/sphinx/source/matlab-source/most/t_most_sp.m new file mode 120000 index 0000000..0521566 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_sp.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_sp.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_spuc.m b/docs/sphinx/source/matlab-source/most/t_most_spuc.m new file mode 120000 index 0000000..576fd5a --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_spuc.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_spuc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_suc.m b/docs/sphinx/source/matlab-source/most/t_most_suc.m new file mode 120000 index 0000000..00b5742 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_suc.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_suc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_tlmp.m b/docs/sphinx/source/matlab-source/most/t_most_tlmp.m new file mode 120000 index 0000000..1633bc5 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_tlmp.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_tlmp.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_uc.m b/docs/sphinx/source/matlab-source/most/t_most_uc.m new file mode 120000 index 0000000..9d10dd0 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_uc.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_uc.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/t_most_w_ds.m b/docs/sphinx/source/matlab-source/most/t_most_w_ds.m new file mode 120000 index 0000000..346e205 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/t_most_w_ds.m @@ -0,0 +1 @@ +../../../../../lib/t/t_most_w_ds.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/test_most.m b/docs/sphinx/source/matlab-source/most/test_most.m new file mode 120000 index 0000000..8a47bbc --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/test_most.m @@ -0,0 +1 @@ +../../../../../lib/t/test_most.m \ No newline at end of file diff --git a/docs/sphinx/source/matlab-source/most/uniformwindprofile.m b/docs/sphinx/source/matlab-source/most/uniformwindprofile.m new file mode 120000 index 0000000..07d9c50 --- /dev/null +++ b/docs/sphinx/source/matlab-source/most/uniformwindprofile.m @@ -0,0 +1 @@ +../../../../../lib/t/uniformwindprofile.m \ No newline at end of file diff --git a/docs/sphinx/source/reference.rst b/docs/sphinx/source/reference.rst new file mode 100644 index 0000000..c17137c --- /dev/null +++ b/docs/sphinx/source/reference.rst @@ -0,0 +1,130 @@ +.. _sec_most_reference: + +Reference +========= + + +Main MOST Functions +------------------- + +Functions to load data for MOST, run the |MOSTname|, and print out some summary results. + +.. toctree:: + + functions/loadmd + functions/most + functions/most_summary + + +Functions for plotting results. + +.. toctree:: + + functions/plot_gen + functions/plot_storage + functions/plot_uc + functions/plot_uc_data + + +Other Functions +--------------- + +Additional functions for use with MOST. + +.. toctree:: + + functions/mostver + functions/addgen2mpc + functions/addstorage + functions/addwind + functions/apply_profile + functions/filter_ramp_transitions + functions/getprofiles + functions/idx_profile + functions/loadstoragedata + functions/loadxgendata + functions/md_init + functions/uniformwindprofile + + +MOST Examples +------------- + +These are examples of using MOST to solve various classes of problems. + +.. toctree:: + + functions/most_ex1_ed + functions/most_ex2_dcopf + functions/most_ex3_dcopf_w_uc + functions/most_ex4_dcopf_ss + functions/most_ex5_mpopf + functions/most_ex6_uc + functions/most_ex7_suc + +Data for MOST examples. + +.. toctree:: + + functions/ex_case3a + functions/ex_case3b + functions/ex_contab + functions/ex_load_profile + functions/ex_storage + functions/ex_transmat + functions/ex_wind + functions/ex_wind_profile + functions/ex_wind_profile_d + functions/ex_wind_uc + functions/ex_xgd + functions/ex_xgd_ramp + functions/ex_xgd_res + functions/ex_xgd_uc + + +MOST Tests +---------- + +These functions test that MOST is installed and functioning as expected. + +.. toctree:: + + functions/test_most + functions/t_most_3b_1_1_0 + functions/t_most_3b_1_1_2 + functions/t_most_3b_3_1_0 + functions/t_most_3b_3_1_2 + functions/t_most_30b_1_1_0 + functions/t_most_30b_1_1_17 + functions/t_most_30b_3_1_0 + functions/t_most_30b_3_1_17 + functions/t_most_fixed_res + functions/t_most_30b_1_1_0_uc + functions/t_most_sp + functions/t_most_spuc + functions/t_most_mpopf + functions/t_most_uc + functions/t_most_suc + functions/t_most_tlmp + functions/t_most_w_ds + +Data for MOST tests. + +.. toctree:: + + functions/c118swf + functions/t_case30_most + functions/t_case3_most + functions/t_case_tlmp + functions/t_case_tlmp_storage + + +Private Functions +----------------- + +The following are private functions that are used to implement functionality used by other functions. + +.. toctree:: + + functions/loadgenericdata + functions/mpoption_info_most diff --git a/docs/src/MOST-manual/MOST-manual.tex b/docs/src/MOST-manual/MOST-manual.tex index 7d39ef0..47ebfa0 100644 --- a/docs/src/MOST-manual/MOST-manual.tex +++ b/docs/src/MOST-manual/MOST-manual.tex @@ -3434,6 +3434,11 @@ \subsection{Version 1.2.x -- released xxx xx, 202x} The \href{https://matpower.org/docs/MOST-manual-1.2.x.pdf}{\most{} 1.2.x User's Manual} is available online.\footnote{\url{https://matpower.org/docs/MOST-manual-1.2.pdf}} +\subsubsection*{New Features} +\begin{itemize} +\item Add Sphinx-based Reference documentation. +\end{itemize} + \subsubsection*{Changes} \begin{itemize} \item Reduce memory requirements for long horizon cases with storage by forming/storing transposes of matrices for storage constraints.\\ diff --git a/lib/addgen2mpc.m b/lib/addgen2mpc.m index d417d21..8737367 100644 --- a/lib/addgen2mpc.m +++ b/lib/addgen2mpc.m @@ -1,5 +1,6 @@ function [mpco, NewGenIdx] = addgen2mpc(mpci, gen, gencost, fuel) -%ADDGEN2MPC Adds a set of generators to a MATPOWER case struct. +% addgen2mpc - Adds a set of generators to a MATPOWER case struct. +% :: % % [NEW_MPC, IDX] = ADDGEN2MPC(MPC, GEN, GENCOST, GEN_TYPE) % @@ -27,7 +28,7 @@ % IDX : generator indices of the newly added generators % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Daniel Munoz-Alvarez and Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/addstorage.m b/lib/addstorage.m index 7323dc2..2e48f20 100644 --- a/lib/addstorage.m +++ b/lib/addstorage.m @@ -1,5 +1,6 @@ function [idx, new_mpc, new_xgd, new_sd] = addstorage(storage, mpc, xgd, sd) -%ADDWIND Adds storage units and corresponding xGen/StorageData to existing data. +% addstorage - Adds storage units and corresponding xGen/StorageData to existing data. +% :: % % [IDX, NEW_MPC] = ADDSTORAGE(STORAGE, MPC) % [IDX, NEW_MPC, NEW_XGD, NEW_SD] = ADDSTORAGE(STORAGE, MPC) @@ -37,10 +38,10 @@ % NEW_XGD : XGD with xGenData for new storage units appended. % NEW_SD : SD with StorageData for new storage units appended. % -% See also LOADSTORAGEDATA, LOADXGENDATA. +% See also loadstoragedata, loadxgendata. % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/addwind.m b/lib/addwind.m index 8c01a0f..ed41ccc 100644 --- a/lib/addwind.m +++ b/lib/addwind.m @@ -1,5 +1,6 @@ function [idx, new_mpc, new_xgd] = addwind(wind, mpc, xgd) -%ADDWIND Adds wind generators and corresponding xGenData to existing data. +% addwind - Adds wind generators and corresponding xGenData to existing data. +% :: % % [IDX, NEW_MPC] = ADDWIND(WIND, MPC) % [IDX, NEW_MPC, NEW_XGD] = ADDWIND(WIND, MPC) @@ -29,10 +30,10 @@ % MPC.GENFUEL (= 'wind'). % NEW_XGD : XGD with xGenData for new wind units appended. % -% See also LOADXGENDATA. +% See also loadxgendata. % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/apply_profile.m b/lib/apply_profile.m index f8f50d3..a78c1fe 100644 --- a/lib/apply_profile.m +++ b/lib/apply_profile.m @@ -1,5 +1,6 @@ function argout = apply_profile(profile, argin, dim) -%APPLY_PROFILE Applies changes defined in a profile to a data structure. +% apply_profile - Applies changes defined in a profile to a data structure. +% :: % % CHGTABS = APPLY_PROFILE( PROFILE, CHGTABSI ) % XGD = APPLY_PROFILE( PROFILE, XGDI, DIM ) @@ -99,7 +100,7 @@ % Created by Daniel Munoz-Alvarez (4/18/2013) % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Daniel Munoz-Alvarez, PSERC Cornell % % This file is part of MOST. diff --git a/lib/filter_ramp_transitions.m b/lib/filter_ramp_transitions.m index 1747c1e..d700a7c 100644 --- a/lib/filter_ramp_transitions.m +++ b/lib/filter_ramp_transitions.m @@ -1,5 +1,7 @@ function md = filter_ramp_transitions(md0, threshold) -%FILTER_RAMP_TRANSITIONS Creates a transition mask for ramp reserves. +% filter_ramp_transitions - Creates a transition mask for ramp reserves. +% :: +% % MD = FILTER_RAMP_TRANSITIONS(MD0, THRESHOLD) % % Creates a transition mask for ramping reserves, including only transitions @@ -9,7 +11,7 @@ % probability of being in state j1, given that you've made it to period t. % MOST -% Copyright (c) 2012-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2012-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/getprofiles.m b/lib/getprofiles.m index 4ff1a5c..1a48a16 100644 --- a/lib/getprofiles.m +++ b/lib/getprofiles.m @@ -1,5 +1,6 @@ function profiles = getprofiles(profilesi, profiles0, idx) -%GETPROFILES Loads profiles, optionally updating 'rows' via an index mapping. +% getprofiles - Loads profiles, optionally updating 'rows' via an index mapping. +% :: % % PROFILES = GETPROFILES(PROFILESI); % PROFILES = GETPROFILES(PROFILESI, PROFILES0); @@ -34,10 +35,10 @@ % profiles = getprofiles('mywindprofile', iwind); % md = loadmd(mpc, 'mytransmat', xgd, [], [], profiles); % -% See also APPLY_PROFILE, IDX_PROFILE. +% See also apply_profile, idx_profile. % MOST -% Copyright (c) 2012-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2012-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/idx_profile.m b/lib/idx_profile.m index 72dbd91..6782590 100644 --- a/lib/idx_profile.m +++ b/lib/idx_profile.m @@ -1,8 +1,9 @@ function [PR_REP, PR_REL, PR_ADD, PR_TCONT, PR_TYPES, PR_TMPCD,... PR_TXGD, PR_TCTD, PR_TSTGD, PR_CHGTYPES] = idx_profile -%IDX_PROFILE Defines constants used by Profiles. +% idx_profile - Defines constants used by Profiles. +% :: % -% [PR_REP, PR_REL, PR_ADD, PR_TCONT, PR_TYPES, PR_TMPCD,... +% [PR_REP, PR_REL, PR_ADD, PR_TCONT, PR_TYPES, PR_TMPCD,... % PR_TXGD, PR_TCTD, PR_TSTGD, PR_CHGTYPES] = idx_profile; % % Indicates and defines numeric and string id's for the types of profiles @@ -103,7 +104,7 @@ % expansion. These "expansions" occur within loadmd(). % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Daniel Munoz-Alvarez and Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/loadgenericdata.m b/lib/loadgenericdata.m index 8087a9f..64ce02d 100644 --- a/lib/loadgenericdata.m +++ b/lib/loadgenericdata.m @@ -1,5 +1,6 @@ function var = loadgenericdata(varfile, vartype, fields, varname, args) -%LOADGENERICDATA Loads data of a specified type from file or data structure. +% loadgenericdata - Loads data of a specified type from file or data structure. +% :: % % VAR = LOADGENERICDATA(VARFILE, VARTYPE) % VAR = LOADGENERICDATA(VARFILE, VARTYPE, FIELDS) @@ -35,7 +36,7 @@ % VAR : Returned data structure of the first matching VARTYPE. % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Daniel Munoz-Alvarez and Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/loadmd.m b/lib/loadmd.m index 81f5383..e271299 100644 --- a/lib/loadmd.m +++ b/lib/loadmd.m @@ -1,56 +1,68 @@ function md = loadmd(mpci, transmati, xgdi, storagei, contabi, profilesi, trajdatai) -%LOADMD Loads all required data and constructs MD for MOST. +% loadmd - Loads all required data and constructs MD for MOST. +% :: % -% MD = LOADMD(MPC) -% MD = LOADMD(MPC, TRANSMAT) -% MD = LOADMD(MPC, TRANSMAT, XGD) -% MD = LOADMD(MPC, TRANSMAT, XGD, SD) -% MD = LOADMD(MPC, TRANSMAT, XGD, SD, CONTAB) -% MD = LOADMD(MPC, TRANSMAT, XGD, SD, CONTAB, PROFILES) -% MD = LOADMD(MPC, TRANSMAT, XGD, SD, CONTAB, PROFILES, TRAJDATA) -% MD = LOADMD(MPC, NT, ...) +% md = loadmd(mpc) +% md = loadmd(mpc, transmat) +% md = loadmd(mpc, transmat, xgd) +% md = loadmd(mpc, transmat, xgd, sd) +% md = loadmd(mpc, transmat, xgd, sd, contab) +% md = loadmd(mpc, transmat, xgd, sd, contab, profiles) +% md = loadmd(mpc, transmat, xgd, sd, contab, profiles, trajdata) +% md = loadmd(mpc, nt, ...) % -% All inputs can have the format described below or can be given as -% strings containing the name of the MAT-file or M-file that contains the -% data in the proper format. +% All inputs can have the format described below or can be given as +% strings containing the name of the MAT-file or M-file that contains the +% data in the proper format. % -% Inputs: -% MPC: a standard MATPOWER case struct, optionally with -% additional fields such as 'genfuel' and 'i' -% NOTE: Bus numbers must be consecutive beginning at 1 -% (i.e. internal ordering). -% TRANSMAT: (optional) NT dimensional cell array of matrices, where -% TRANSMAT{t} is an NJ(t) x NJ(t-1) matrix containing the -% transition probabilities from period t-1 to period t. The -% first element TRANSMAT{1} is a column vector of transition -% probabilities from period 0 (NJ(0) = 1) to period 1. For -% deterministic cases, TRANSMAT can be specified simply as -% an integer NT (number of periods), which gets expanded -% internally to a cell array of 1's. Default value is 1. -% XGD: (optional) xGenData struct, see LOADXGENDATA for details. -% SD: (optional) StorageData struct, see LOADSTORAGEDATA for -% details. -% CONTAB: (optional) contingency table with master set of -% contingencies used for security throughout entire horizon -% PROFILES: (optional) a struct array of Profiles (see IDX_PROFILE -% and APPLY_PROFLE for details), specifying changes in the -% system and operational conditions, xGenData, StorageData -% and/or contingencies across time periods and scenarios. -% Alternatively, for backward compatibility with the -% older centroids format, PROFILES can take the form of -% a struct with the following fields: -% .wind: 3-dim array (NT x NJ_MAX x num wind sites) -% .load: 3-dim array (NT x NJ_MAX x num load zones) -% If empty, no changes are made across time. -% TRAJDATA: (optional) struct array in same format as PROFILES -% specifying a set of trajectories for a stage 2 solution. -% The J dimension of the profile in this case indexes the -% trajectories. +% Inputs: +% mpc (struct) : a standard |MATPOWER| case struct, optionally with +% additional fields such as ``genfuel`` and :samp:`i{}` +% +% **Note:** Bus numbers must be consecutive beginning at 1 +% *(i.e. internal ordering).* +% transmat (cell array) : *(optional)* :math:`n_t` dimensional cell array +% of matrices, where ``transmat{t}`` is an :math:`n_j^t \times n_j^{t-1}` +% matrix containing the transition probabilities from period :math:`t-1` +% to period :math:`t`. The first element ``transmat{1}`` is a column +% vector of transition probabilities from period 0 (:math:`n_j^0 = 1`) +% to period 1. Default value is the integer 1 (see ``nt`` below). +% nt (integer) : *(optional)* For deterministic cases, ``transmat`` can +% be specified simply as an integer ``nt`` (:math:`n_t`, number of +% periods), which gets expanded internally to a cell array of 1's. +% Default value is 1. +% xgd (struct) : *(optional)* xGenData struct, see loadxgendata for details. +% sd (struct) : *(optional)* StorageData struct, see loadstoragedata for +% details. +% contab (double) : *(optional)* contingency table with master set of +% contingencies used for security throughout entire horizon +% profiles (struct array) : *(optional)* a struct array of Profiles +% (see idx_profile and apply_profile for details), specifying changes +% in the system and operational conditions, xGenData, StorageData +% and/or contingencies across time periods and scenarios. Alternatively, +% for backward compatibility with the older centroids format, +% ``profiles`` can take the form of a struct with the following fields: +% +% - ``wind`` - 3-dim array (:math:`n_t \times n_j^{max} \times n_w`), +% :math:`n_w` is the number of wind sites +% - ``load`` - 3-dim array (:math:`n_t \times n_j^{max} \times n_z`), +% :math:`n_z` is the number of load zones +% +% If empty, no changes are made across time. +% trajdata (struct) : *(optional)* struct array in same format as +% ``profiles`` specifying a set of trajectories for a stage 2 solution. +% The :math:`j` dimension of the profile in this case indexes the +% trajectories. +% +% Output: +% md (struct) : MOST data structure (see |MOSTman| for details) +% +% See also most. % Created by Daniel Munoz-Alvarez (2/28/2013) % MOST -% Copyright (c) 2013-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Daniel Munoz-Alvarez and Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/loadstoragedata.m b/lib/loadstoragedata.m index 3d5fb58..c845730 100644 --- a/lib/loadstoragedata.m +++ b/lib/loadstoragedata.m @@ -1,5 +1,6 @@ function sd = loadstoragedata(sd_table, mpc) -%LOADSTORAGEDATA Load StorageData table into StorageData struct. +% loadstoragedata - Load StorageData table into StorageData struct. +% :: % % SD = LOADSTORAGEDATA(SD_TABLE) % SD = LOADSTORAGEDATA(SD_TABLE, GEN) @@ -63,7 +64,7 @@ % .rho (ns x 1) or (1 x 1) % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/loadxgendata.m b/lib/loadxgendata.m index 188110a..08c36c5 100644 --- a/lib/loadxgendata.m +++ b/lib/loadxgendata.m @@ -1,5 +1,6 @@ function xgd = loadxgendata(xgd_table, mpc) -%LOADXGENDATA Load xGenData table into xGenData struct. +% loadxgendata - Load xGenData table into xGenData struct. +% :: % % XGD = LOADXGENDATA(XGD_TABLE) % XGD = LOADXGENDATA(XGD_TABLE, GEN) @@ -63,7 +64,7 @@ % ** Requires CommitKey be present and non-empty. % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/md_init.m b/lib/md_init.m index e92442b..f85c7f2 100644 --- a/lib/md_init.m +++ b/lib/md_init.m @@ -1,12 +1,14 @@ function md = md_init -%MD_INIT MOST Data structure Initialization +% md_init - MOST Data structure Initialization +% :: +% % MD = MD_INIT % % Creates an empty MOST Data struct (MD) with all fields required for % MOST, both input and output fields. % MOST -% Copyright (c) 2010-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2010-2024, Power Systems Engineering Research Center (PSERC) % by Carlos E. Murillo-Sanchez, PSERC Cornell & Universidad Nacional de Colombia % and Ray Zimmerman, PSERC Cornell % diff --git a/lib/most.m b/lib/most.m index c974074..7161cc7 100644 --- a/lib/most.m +++ b/lib/most.m @@ -1,63 +1,68 @@ function mdo = most(mdi, mpopt) -%MOST MATPOWER Optimal Scheduling Tool -% MDO = MOST(MDI) -% MDO = MOST(MDI, MPOPT) +% most - The |MOSTname| (MOST) +% :: % -% Solves a multiperiod, stochastic, contingency constrained, optimal -% power flow problem with linear constraints and unit commitment. -% Depending on inputs it may include DC power flow constraints or -% a simple total power balance condition. +% mdo = most(mdi) +% mdo = most(mdi, mpopt) % -% Inputs: -% MDI MOST data structure, input -% (see MOST User's Manual for details) -% MPOPT MATPOWER options struct, relevant fields are (default -% value in parens): -% verbose - see 'help mpoption' -% - e.g. cplex, gurobi, etc, -% see 'help mpoption' -% most.build_model (1) - build the MIQP, both constraints and -% standard costs (not coordination cost) and store in -% QP field of MDO -% most.solve_model (1) - solve the MIQP; if coordination -% cost exists, update it; requires either 'most.build_model' -% set to 1 or MDI.QP must contain previously built model -% most.resolve_new_cost (0) - use when MIQP is already built and -% unchanged except for new coordination cost -% most.dc_model (1) - use DC flow network model as opposed to simple -% generation = demand constraint -% most.fixed_res (-1) - include fixed zonal reserve contstraints, -% -1 = if present, 1 = always include, 0 = never include -% most.q_coordination (0) - create Qg variables for reactive power -% coordination -% most.security_constraints (-1) - include contingency contstraints, -% -1 = if present, 1 = always include, 0 = never include -% most.storage.terminal_target (-1) - constrain the expected terminal -% storage to target value, if present (1 = always, 0 = never) -% most.storage.cyclic (0) - if 1, then initial storage is a variable -% constrained to = final expected storage; can't be -% simultaneously true with most.storage.terminal_target -% most.uc.run (-1) - flag to indicate whether to perform unit -% commitment; 0 = do NOT perform UC, 1 = DO perform UC, -% -1 = perform UC if MDI.UC.CommitKey is present/non-empty -% most.uc.cyclic (0) - commitment restrictions (e.g. min up/down -% times) roll over from end of horizon back to beginning -% most.alpha (0) - 0 = contingencies happen at beginning of period, -% 1 = at end of period -% most.solver ('DEFAULT') - see ALG argument to OPT_MODEL/SOLVE -% (i.e. MIQPS_MASTER or QPS_MASTER) for details -% most.skip_prices (0) - skip price computation stage for mixed -% integer problems, see MIQPS_MASTER for details -% most.price_stage_warn_tol (1e-7) - tolerance on the objective fcn -% value and primal variable relative match required to avoid -% mis-match warning message, see MIQPS_MASTER for details +% MOST solves a multiperiod, stochastic, contingency constrained, +% optimal power flow problem with linear constraints and unit commitment. +% Depending on inputs it may include DC power flow constraints or +% a simple total power balance condition. % -% Outputs: -% MDO MOST data structure, output -% (see MOST User's Manual for details) +% Inputs: +% mdi (struct) : MOST data structure, input (see |MOSTman| for details) +% mpopt (struct) : |MATPOWER| options struct, relevant fields are +% *(default value in parens)*: +% +% - ``verbose`` - see ``'help mpoption'`` +% - :samp:`{}` - e.g. cplex, gurobi, etc, +% see ``'help mpoption'`` +% - ``most.build_model`` *(1)* - build the MIQP, both constraints and +% standard costs (not coordination cost) and store in +% QP field of ``mdo`` +% - ``most.solve_model`` *(1)* - solve the MIQP; if coordination +% cost exists, update it; requires either ``'most.build_model'`` +% set to 1 or ``mdi.qp`` must contain previously built model +% - ``most.resolve_new_cost`` *(0)* - use when MIQP is already built +% and unchanged except for new coordination cost +% - ``most.dc_model`` *(1)* - use DC flow network model as opposed to +% simple *generation = demand* constraint +% - ``most.fixed_res`` *(-1)* - include fixed zonal reserve contstraints, +% -1 = if present, 1 = always include, 0 = never include +% - ``most.q_coordination`` *(0)* - create ``Qg`` variables for +% reactive power coordination +% - ``most.security_constraints`` *(-1)* - include contingency +% contstraints, -1 = if present, 1 = always include, 0 = never include +% - ``most.storage.terminal_target`` *(-1)* - constrain the expected +% terminal storage to target value, -1 = if present, 1 = always, +% 0 = never +% - ``most.storage.cyclic`` *(0)* - if 1, then initial storage is a +% variable constrained to = final expected storage; can't be +% simultaneously true with ``most.storage.terminal_target`` +% - ``most.uc.run`` *(-1)* - flag to indicate whether to perform unit +% commitment; 0 = do *not* perform UC, 1 = *do* perform UC, +% -1 = perform UC if ``mdi.uc.CommitKey`` is present/non-empty +% - ``most.uc.cyclic`` *(0)* - commitment restrictions (e.g. min +% up/down times) roll over from end of horizon back to beginning +% - ``most.alpha`` *(0)* - 0 = contingencies happen at beginning of +% period, 1 = at end of period +% - ``most.solver`` *(* ``'DEFAULT'`` *)* - see ``alg`` argument to +% :meth:`opt_model.solve` (i.e. miqps_master or qps_master) for +% details +% - ``most.skip_prices`` *(0)* - skip price computation stage for mixed +% integer problems, see miqps_master for details +% - ``most.price_stage_warn_tol`` *(1e-7)* - tolerance on the objective +% function value and primal variable relative match required to avoid +% mis-match warning message, see miqps_master for details +% +% Outputs: +% mdo (struct) : MOST data structure, output (see |MOSTman| for details) +% +% See also loadmd. % MOST -% Copyright (c) 2010-2023, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2010-2024, Power Systems Engineering Research Center (PSERC) % by Carlos E. Murillo-Sanchez, PSERC Cornell & Universidad Nacional de Colombia % and Ray Zimmerman, PSERC Cornell % diff --git a/lib/most_summary.m b/lib/most_summary.m index a96b299..0b62e09 100644 --- a/lib/most_summary.m +++ b/lib/most_summary.m @@ -1,32 +1,50 @@ function mso = most_summary(mdo) -%MOST_SUMMARY Collects and optionally prints a summary of MOST results. -% MS = MOST_SUMMARY(MDO) +% most_summary - Collects and optionally prints a summary of MOST results. +% :: % -% Note: Consider this function experimental. It is included because it -% is often better than nothing, though it is very incomplete. +% ms = most_summary(mdo) % -% Given a MOST data struct returned by MOST, returns a struct with the -% following fields: -% f - objective function value -% nb - number of buses -% ng - number of generators (incl. storage, disp. load, etc.) -% nl - number of branches -% nt - number of periods in planning horizon -% nj_max - max number of scenarios per period -% nc_max - max number of contingencies per scenario in any period -% Pg - ng x nt x nj_max x (nc_max+1), real power generation -% Rup - ng x nt, upward ramping reserve quantities -% Rdn - ng x nt, downward ramping reserve quantities -% Pf - nl x nt x nj_max x (nc_max+1), real power generation -% u - ng x nt x nj_max x (nc_max+1), generator commitment status -% lamP - nb x nt x nj_max x (nc_max+1), shadow price on power balance -% muF - nl x nt x nj_max x (nc_max+1), shadow price on flow limits +% .. note:: Consider this function experimental. It is included because +% it is often better than nothing, though it is very incomplete. % -% Printing to the console is currently controlled by the MDO.QP.opt.verbose -% flag. +% Input: +% mdo (struct) : MOST data structure, output (see |MOSTman| for details) +% +% Output: +% ms (struct) : MOST summary struct with the following fields: +% +% ====== ======================================================= +% name description +% ====== ======================================================= +% f objective function value +% nb :math:`n_b`, number of buses +% ng :math:`n_g`, number of generators *(including storage, +% dispatchable load, etc.)* +% nl :math:`n_l`, number of branches +% nt :math:`n_t`, number of periods in planning horizon +% nj_max :math:`n_j^{max}`, max number of scenarios per period +% nc_max :math:`n_c^{max}`, max number of contingencies per scenario +% in any period +% Pg :math:`n_g \times n_t \times n_j^{max} \times (n_c^{max}+1)`, +% real power generation (MW) +% Rup :math:`n_g \times n_t`, upward ramping reserve quantities (MW) +% Rdn :math:`n_g \times n_t`, downward ramping reserve quantities +% (MW) +% Pf :math:`n_l \times n_t \times n_j^{max} \times (n_c^{max}+1)`, +% real power branch flow (MW) +% u :math:`n_g \times n_t \times n_j^{max} \times (n_c^{max}+1)`, +% generator commitment status (0 or 1) +% lamP :math:`n_b \times n_t \times n_j^{max} \times (n_c^{max}+1)`, +% shadow price on power balance ($/MWh) +% muF :math:`n_l \times n_t \times n_j^{max} \times (n_c^{max}+1)`, +% shadow price on flow limits ($/MWh) +% ====== ======================================================= +% +% Printing to the console is currently controlled by the +% ``mdo.qp.opt.verbose`` flag. % MOST -% Copyright (c) 2015-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/mostver.m b/lib/mostver.m index 0105aa6..8f4d5ad 100644 --- a/lib/mostver.m +++ b/lib/mostver.m @@ -1,15 +1,22 @@ function rv = mostver(varargin) -%MOSTVER Prints or returns MOST version info for current installation. -% V = MOSTVER returns the current MOST version number. -% V = MOSTVER('all') returns a struct with the fields Name, Version, -% Release and Date (all strings). Calling MOSTVER without assigning the -% return value prints the version and release date of the current -% installation of MOST. +% mostver - Prints or returns installed MOST version info. +% :: % -% See also MPVER. +% mostver +% v = mostver +% v = mostver('all') +% +% When called with an output argument and no input argument, mostver +% returns the current MOST version numbers. With an input argument +% (e.g. ``'all'``) it returns a struct with the fields ``Name``, +% ``Version``, ``Release``, and ``Date`` *(all char arrays)*. Calling +% mostver without assigning the return value prints the version and +% release date of the current installation of MOST. +% +% See also mpver. % MOST -% Copyright (c) 2010-2023, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2010-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. @@ -19,7 +26,7 @@ v = struct( 'Name', 'MOST', ... 'Version', '1.2+', ... 'Release', '', ... - 'Date', '08-Nov-2023' ); + 'Date', '15-Mar-2024' ); if nargout > 0 if nargin > 0 rv = v; diff --git a/lib/mpoption_info_most.m b/lib/mpoption_info_most.m index ff1d018..528cddf 100644 --- a/lib/mpoption_info_most.m +++ b/lib/mpoption_info_most.m @@ -1,5 +1,6 @@ function opt = mpoption_info_most(selector) -%MPOPTION_INFO_MOST Returns MATPOWER option info for MOST. +% mpoption_info_most - Returns MATPOWER option info for MOST. +% :: % % DEFAULT_OPTS = MPOPTION_INFO_MOST('D') % VALID_OPTS = MPOPTION_INFO_MOST('V') @@ -15,10 +16,10 @@ % of option names or modify option setting/copying behavior for this % subset of optional MATPOWER options. % -% See also MPOPTION. +% See also mpoption. % MOST -% Copyright (c) 2014-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2014-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/plot_gen.m b/lib/plot_gen.m index c5a7cd2..46e091d 100644 --- a/lib/plot_gen.m +++ b/lib/plot_gen.m @@ -1,5 +1,6 @@ function hh = plot_gen(md, idx, varargin) -%PLOT_GEN Plot generator results +% plot_gen - Plot generator results +% :: % % PLOT_GEN(MD) % PLOT_GEN(MD, IDX) @@ -38,7 +39,7 @@ % indicate dispatchable load in title). % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/plot_storage.m b/lib/plot_storage.m index 00e0416..ce4d7d5 100644 --- a/lib/plot_storage.m +++ b/lib/plot_storage.m @@ -1,5 +1,6 @@ function hh = plot_storage(md, idx, varargin) -%PLOT_STORAGE Plot storage unit results +% plot_storage - Plot storage unit results +% :: % % PLOT_STORAGE(MD) % PLOT_STORAGE(MD, IDX) @@ -40,7 +41,7 @@ % TO DO: Do initial invisible plot to get v axis parameters. % MOST -% Copyright (c) 2013-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/plot_uc.m b/lib/plot_uc.m index ddf6420..a97c2bd 100644 --- a/lib/plot_uc.m +++ b/lib/plot_uc.m @@ -1,5 +1,6 @@ function hh = plot_uc(md, varargin) -%PLOT_UC Plot generator commitment summary +% plot_uc - Plot generator commitment summary +% :: % % PLOT_UC(MD) % PLOT_UC(MD, IDX) @@ -42,7 +43,7 @@ % Returns handle to current figure window. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/plot_uc_data.m b/lib/plot_uc_data.m index 60cb5df..8047730 100644 --- a/lib/plot_uc_data.m +++ b/lib/plot_uc_data.m @@ -1,5 +1,6 @@ function hh = plot_uc_data(uc1, uc2, optin) -%PLOT_UC_DATA Plot generator commitment summary +% plot_uc_data - Plot generator commitment summary +% :: % % PLOT_UC_DATA(UC1, UC2, OPT) % H = PLOT_UC_DATA(UC1, ...) @@ -35,7 +36,7 @@ % Returns handle to current figure window. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/c118swf.m b/lib/t/c118swf.m index d1ae49a..6f1701a 100644 --- a/lib/t/c118swf.m +++ b/lib/t/c118swf.m @@ -1,5 +1,7 @@ function mpc = c118swf -%CASE118 Power flow data for IEEE 118 bus test case. +% c118swf - Power flow data for IEEE 118 bus test case. +% :: +% % Please see CASEFORMAT for details on the case file format. % This data was converted from IEEE Common Data Format % (ieee118cdf.txt) on 20-Sep-2004 by cdf2matp, rev. 1.11 @@ -12,7 +14,7 @@ % % 08/25/93 UW ARCHIVE 100.0 1961 W IEEE 118 Bus Test Case % -% Updates: Sep 15'2010 by CM and CZ. Buses grouped on four areas; +% Updates: Sep 15'2010 by CM and CZ. Buses grouped on four areas; % Branch thermal limits incorporated based on: KV level, same % cable, and safe security factor (assuming bundled config on 345KV % and double circuit on 161 and 138KV lines). @@ -20,7 +22,7 @@ % Split data for parallel lines that initially had aggregated params % RAMP_AGC,RAMP_10 & RAMP_30 set to 20% of PMAX for each generator % function change of name to c118 -% Aug 13'2012 by CM and DM. +% Aug 13'2012 by CM and DM. % The 118-bus test system was modified in order to allow the % loading factor to be considerably increased without compromising % the feasibility of the system. The procedure followed is diff --git a/lib/t/ex_case3a.m b/lib/t/ex_case3a.m index ddde430..8bdbf11 100644 --- a/lib/t/ex_case3a.m +++ b/lib/t/ex_case3a.m @@ -1,9 +1,10 @@ function mpc = ex_case3a -%EX_CASE3A Three bus example system. -% Please see CASEFORMAT for details on the case file format. +% ex_case3a - Three bus example system. +% +% Please see caseformat for details on the case file format. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_case3b.m b/lib/t/ex_case3b.m index e79d85b..030bda5 100644 --- a/lib/t/ex_case3b.m +++ b/lib/t/ex_case3b.m @@ -1,13 +1,16 @@ function mpc = ex_case3b -%EX_CASE3B Three bus example system for stochastic unit commitment. -% Same as EX_CASE3A with the following changes: -% - Non-zero PMIN values for generators -% - Linear (vs quadratic) generator costs -% - Includes some STARTUP and SHUTDOWN costs -% Please see CASEFORMAT for details on the case file format. +% ex_case3b - Three bus example system for stochastic unit commitment. +% +% Same as ex_case3a with the following changes: +% +% - Non-zero ``PMIN`` values for generators +% - Linear (vs quadratic) generator costs +% - Includes some ``STARTUP`` and ``SHUTDOWN`` costs +% +% Please see caseformat for details on the case file format. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_contab.m b/lib/t/ex_contab.m index 4d576e5..f136ac7 100644 --- a/lib/t/ex_contab.m +++ b/lib/t/ex_contab.m @@ -1,8 +1,8 @@ function contab = ex_contab -%EX_CONTAB Example contingency data for stochastic unit commitment. +% ex_contab - Example contingency data for stochastic unit commitment. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_load_profile.m b/lib/t/ex_load_profile.m index 6ce5e52..ce2f58d 100644 --- a/lib/t/ex_load_profile.m +++ b/lib/t/ex_load_profile.m @@ -1,8 +1,8 @@ function loadprofile = ex_load_profile -%EX_LOAD_PROFILE Example load profile data file for stochastic unit commitment. +% ex_load_profile - Example load profile data file for stochastic unit commitment. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_storage.m b/lib/t/ex_storage.m index 013e0d3..c0da2b3 100644 --- a/lib/t/ex_storage.m +++ b/lib/t/ex_storage.m @@ -1,8 +1,8 @@ function storage = ex_storage(mpc) -%EX_STORAGE Example Storage data file for stochastic unit commitment. +% ex_storage - Example Storage data file for stochastic unit commitment. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_transmat.m b/lib/t/ex_transmat.m index 4a5888c..ba1ceb6 100644 --- a/lib/t/ex_transmat.m +++ b/lib/t/ex_transmat.m @@ -1,8 +1,8 @@ function transmat = ex_transmat(nt) -%EX_TRANSMAT Example transition probability matrix definition. +% ex_transmat - Example transition probability matrix definition. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_wind.m b/lib/t/ex_wind.m index e15b23b..2e1b8fe 100644 --- a/lib/t/ex_wind.m +++ b/lib/t/ex_wind.m @@ -1,8 +1,8 @@ function wind = ex_wind(mpc) -%EX_WIND Example Wind data file for stochastic OPF. +% ex_wind - Example Wind data file for stochastic OPF. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_wind_profile.m b/lib/t/ex_wind_profile.m index b1b7538..95eb9f9 100644 --- a/lib/t/ex_wind_profile.m +++ b/lib/t/ex_wind_profile.m @@ -1,8 +1,8 @@ function windprofile = ex_wind_profile -%EX_WIND_PROFILE Example wind profile data for stochastic unit commitment. +% ex_wind_profile - Example wind profile data for stochastic unit commitment. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_wind_profile_d.m b/lib/t/ex_wind_profile_d.m index 07493d6..c9cc4f6 100644 --- a/lib/t/ex_wind_profile_d.m +++ b/lib/t/ex_wind_profile_d.m @@ -1,8 +1,8 @@ function windprofile = ex_wind_profile_d -%EX_WIND_PROFILE_D Example wind profile data for deterministic unit commitment. +% ex_wind_profile_d - Example wind profile data for deterministic unit commitment. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_wind_uc.m b/lib/t/ex_wind_uc.m index b37a3d6..87cc971 100644 --- a/lib/t/ex_wind_uc.m +++ b/lib/t/ex_wind_uc.m @@ -1,8 +1,8 @@ function wind = ex_wind_uc(mpc) -%EX_WIND_UC Example Wind data file for stochastic unit commitment. +% ex_wind_uc - Example Wind data file for stochastic unit commitment. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_xgd.m b/lib/t/ex_xgd.m index 37be68f..e3b71d0 100644 --- a/lib/t/ex_xgd.m +++ b/lib/t/ex_xgd.m @@ -1,8 +1,8 @@ function xgd_table = ex_xgd(mpc) -%EX_XGD Example xGenData table for stochastic OPF. +% ex_xgd - Example xGenData table for stochastic OPF. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_xgd_ramp.m b/lib/t/ex_xgd_ramp.m index af1cf51..85c4fa6 100644 --- a/lib/t/ex_xgd_ramp.m +++ b/lib/t/ex_xgd_ramp.m @@ -1,8 +1,8 @@ function xgd_table = ex_xgd_ramp(mpc) -%EX_XGD_RAMP Example xGenData table for multiperiod DC OPF with ramping. +% ex_xgd_ramp - Example xGenData table for multiperiod DC OPF with ramping. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_xgd_res.m b/lib/t/ex_xgd_res.m index a80e2c0..70fed3a 100644 --- a/lib/t/ex_xgd_res.m +++ b/lib/t/ex_xgd_res.m @@ -1,8 +1,8 @@ function xgd_table = ex_xgd_res(mpc) -%EX_XGD_RES Example xGenData table for stochastic OPF w/reserve costs. +% ex_xgd_res - Example xGenData table for stochastic OPF w/reserve costs. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/ex_xgd_uc.m b/lib/t/ex_xgd_uc.m index 057a9ae..5b7e43a 100644 --- a/lib/t/ex_xgd_uc.m +++ b/lib/t/ex_xgd_uc.m @@ -1,8 +1,8 @@ function xgd_table = ex_xgd_uc(mpc) -%EX_XGD_UC Example xGenData table for stochastic unit commitment. +% ex_xgd_uc - Example xGenData table for stochastic unit commitment. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/generate_most_autodoc.m b/lib/t/generate_most_autodoc.m new file mode 100644 index 0000000..1cc7826 --- /dev/null +++ b/lib/t/generate_most_autodoc.m @@ -0,0 +1,115 @@ +function generate_most_autodoc(install_dir) +% generate_most_autodoc - Generate the stubs and symlinks for Ref Manual. +% :: +% +% generate_most_autodoc(install_dir) +% +% Inputs: +% install_dir (char array) : path to the install directory for the package +% +% Creates the .rst stubs and symlinks to the source files for all functions +% and classes to be included in the Reference Manual. Creates all of the +% inputs (lists of functions and classes) to pass to generate_autodoc_stubs +% and generate_source_symlinks. + +% MOST +% Copyright (c) 2023-2024, Power Systems Engineering Research Center (PSERC) +% by Ray Zimmerman, PSERC Cornell +% +% This file is part of MOST. +% Covered by the 3-clause BSD License (see LICENSE file for details). +% See https://github.com/MATPOWER/most for more info. + +if nargin < 1 + matpower_dir = '~/dev/projects/most/'; +end + +sphinx_src_dir = [matpower_dir 'docs/sphinx/source/']; + +lib_fcns = { + 'addgen2mpc', ... + 'addstorage', ... + 'addwind', ... + 'apply_profile', ... + 'filter_ramp_transitions', ... + 'getprofiles', ... + 'idx_profile', ... + 'loadgenericdata', ... + 'loadmd', ... + 'loadstoragedata', ... + 'loadxgendata', ... + 'md_init', ... + 'most', ... + 'most_summary', ... + 'mostver', ... + 'mpoption_info_most', ... + 'plot_gen', ... + 'plot_storage', ... + 'plot_uc', ... + 'plot_uc_data', ... +}; +lib_t_fcns = { + 'c118swf', ... + 'ex_case3a', ... + 'ex_case3b', ... + 'ex_contab', ... + 'ex_load_profile', ... + 'ex_storage', ... + 'ex_transmat', ... + 'ex_wind', ... + 'ex_wind_profile', ... + 'ex_wind_profile_d', ... + 'ex_wind_uc', ... + 'ex_xgd', ... + 'ex_xgd_ramp', ... + 'ex_xgd_res', ... + 'ex_xgd_uc', ... + 'most_ex1_ed', ... + 'most_ex2_dcopf', ... + 'most_ex3_dcopf_w_uc', ... + 'most_ex4_dcopf_ss', ... + 'most_ex5_mpopf', ... + 'most_ex6_uc', ... + 'most_ex7_suc', ... + 't_case30_most', ... + 't_case3_most', ... + 't_case_tlmp', ... + 't_case_tlmp_storage', ... + 't_most_30b_1_1_0', ... + 't_most_30b_1_1_0_uc', ... + 't_most_30b_1_1_17', ... + 't_most_30b_3_1_0', ... + 't_most_30b_3_1_17', ... + 't_most_3b_1_1_0', ... + 't_most_3b_1_1_2', ... + 't_most_3b_3_1_0', ... + 't_most_3b_3_1_2', ... + 't_most_fixed_res', ... + 't_most_mpopf', ... + 't_most_sp', ... + 't_most_spuc', ... + 't_most_suc', ... + 't_most_tlmp', ... + 't_most_uc', ... + 't_most_w_ds', ... + 'test_most', ... + 'uniformwindprofile', ... +}; +% 'generate_most_autodoc', ... + + +in = struct(... + 'function', struct(... + 'destdir', 'functions', ... + 'gh_base_url', 'https://github.com/MATPOWER/most/blob/master', ... + 'list', struct(... + 'mod', {'most', 'most'}, ... + 'src_path', {'lib', 'lib/t'}, ... + 'names', {lib_fcns, lib_t_fcns} ... + ) ... + ) ... +); + +%% create stubs and symlinks for reference manual +generate_autodoc_stubs(in, sphinx_src_dir); +generate_source_symlinks(in, [sphinx_src_dir 'matlab-source/'], '../../../../../'); diff --git a/lib/t/most_ex1_ed.m b/lib/t/most_ex1_ed.m index a511501..d622124 100644 --- a/lib/t/most_ex1_ed.m +++ b/lib/t/most_ex1_ed.m @@ -1,8 +1,8 @@ function most_ex1_ed(quiet) -%MOST_EX1_ED Examples of deterministic economic dispatch. +% most_ex1_ed - Examples of deterministic economic dispatch. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/most_ex2_dcopf.m b/lib/t/most_ex2_dcopf.m index 3d02a05..002ca14 100644 --- a/lib/t/most_ex2_dcopf.m +++ b/lib/t/most_ex2_dcopf.m @@ -1,8 +1,8 @@ function most_ex2_dcopf(quiet) -%MOST_EX2_DCOPF Examples of deterministic DC optimal power flow. +% most_ex2_dcopf - Examples of deterministic DC optimal power flow. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/most_ex3_dcopf_w_uc.m b/lib/t/most_ex3_dcopf_w_uc.m index 871e3c8..bcb9ccd 100644 --- a/lib/t/most_ex3_dcopf_w_uc.m +++ b/lib/t/most_ex3_dcopf_w_uc.m @@ -1,8 +1,8 @@ function most_ex3_dcopf_w_uc(quiet) -%MOST_EX3_DCOPF_W_UC Examples of deterministic DC optimal power flow with UC. +% most_ex3_dcopf_w_uc - Examples of deterministic DC optimal power flow with UC. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/most_ex4_dcopf_ss.m b/lib/t/most_ex4_dcopf_ss.m index e86a891..8a0af5e 100644 --- a/lib/t/most_ex4_dcopf_ss.m +++ b/lib/t/most_ex4_dcopf_ss.m @@ -1,8 +1,8 @@ function most_ex4_dcopf_ss(quiet) -%MOST_EX4_DCOPF_SS Examples of secure and stochastic DC OPF problems. +% most_ex4_dcopf_ss - Examples of secure and stochastic DC OPF problems. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/most_ex5_mpopf.m b/lib/t/most_ex5_mpopf.m index 1983618..199522d 100644 --- a/lib/t/most_ex5_mpopf.m +++ b/lib/t/most_ex5_mpopf.m @@ -1,8 +1,8 @@ function most_ex5_mpopf(quiet) -%MOST_EX5_MPOPF Examples of deterministic multiperiod DC OPF problems. +% most_ex5_mpopf - Examples of deterministic multiperiod DC OPF problems. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/most_ex6_uc.m b/lib/t/most_ex6_uc.m index cf0376a..2e154a8 100644 --- a/lib/t/most_ex6_uc.m +++ b/lib/t/most_ex6_uc.m @@ -1,8 +1,8 @@ function most_ex6_uc(quiet) -%MOST_EX6_UC Examples of deterministic unit commitment problems. +% most_ex6_uc - Examples of deterministic unit commitment problems. % MOST -% Copyright (c) 2015-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/most_ex7_suc.m b/lib/t/most_ex7_suc.m index 9de2cca..729f419 100644 --- a/lib/t/most_ex7_suc.m +++ b/lib/t/most_ex7_suc.m @@ -1,8 +1,8 @@ function most_ex7_suc(quiet) -%MOST_EX7_SUC Examples of secure and stochastic unit commitment problems. +% most_ex7_suc - Examples of secure and stochastic unit commitment problems. % MOST -% Copyright (c) 2015-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_case30_most.m b/lib/t/t_case30_most.m index 0f9bab4..0b66104 100644 --- a/lib/t/t_case30_most.m +++ b/lib/t/t_case30_most.m @@ -1,8 +1,10 @@ function mpc = t_case30_most -%T_CASE30_MOST Modified case30.m for security constrained OPF. -% Please see CASEFORMAT for details on the case file format. +% t_case30_most - Modified case30.m for security constrained OPF. +% +% Please see caseformat for details on the case file format. % % This is case30V19.m with the following modifications: +% % 1. Generator costs (not including dispatchable loads) have % been converted back to single segment piece-wise linear % in order to test the automatic convert to polynomial diff --git a/lib/t/t_case3_most.m b/lib/t/t_case3_most.m index a2d63f4..f117d11 100644 --- a/lib/t/t_case3_most.m +++ b/lib/t/t_case3_most.m @@ -1,9 +1,10 @@ function mpc = t_case3_most -%T_CASE3_MOST Three bus example system -% Please see CASEFORMAT for details on the case file format. +% t_case3_most - Three bus example system +% +% Please see caseformat for details on the case file format. % MOST -% Copyright (c) 2015-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_case_tlmp.m b/lib/t/t_case_tlmp.m index 449ebf4..c02d78f 100644 --- a/lib/t/t_case_tlmp.m +++ b/lib/t/t_case_tlmp.m @@ -1,9 +1,10 @@ function mpc = t_case_tlmp -%T_CASE_TLMP Single bus, 2-gen case for TLMP examples from Cong Chen -% Please see CASEFORMAT for details on the case file format. +% t_case_tlmp - Single bus, 2-gen case for TLMP examples from Cong Chen +% +% Please see caseformat for details on the case file format. % MOST -% Copyright (c) 2022, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2022-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_case_tlmp_storage.m b/lib/t/t_case_tlmp_storage.m index 7a3801f..f262fd3 100644 --- a/lib/t/t_case_tlmp_storage.m +++ b/lib/t/t_case_tlmp_storage.m @@ -1,9 +1,10 @@ function mpc = t_case_tlmp_storage -%T_CASE_TLMP_STORAGE Single bus, 1-gen, 1-storage case for TLMP example from Cong Chen -% Please see CASEFORMAT for details on the case file format. +% t_case_tlmp_storage - Single bus, 1-gen, 1-storage case for TLMP example from Cong Chen +% +% Please see caseformat for details on the case file format. % MOST -% Copyright (c) 2022, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2022-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_30b_1_1_0.m b/lib/t/t_most_30b_1_1_0.m index 128a7cf..b140719 100644 --- a/lib/t/t_most_30b_1_1_0.m +++ b/lib/t/t_most_30b_1_1_0.m @@ -1,8 +1,8 @@ function t_most_30b_1_1_0(quiet) -%T_MOST_30B_1_1_0 Tests for MOST. +% t_most_30b_1_1_0 - Tests for MOST, 30-bus, 1 period, no contingencies. % MOST -% Copyright (c) 2009-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2009-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_30b_1_1_0_uc.m b/lib/t/t_most_30b_1_1_0_uc.m index 458cc33..583fff9 100644 --- a/lib/t/t_most_30b_1_1_0_uc.m +++ b/lib/t/t_most_30b_1_1_0_uc.m @@ -1,8 +1,8 @@ function t_most_30b_1_1_0_uc(quiet) -%T_MOST_30B_1_1_0_UC Tests for MOST. +% t_most_30b_1_1_0_uc - Tests for MOST, 30-bus, 1 period, no contingencies, UC. % MOST -% Copyright (c) 2009-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2009-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_30b_1_1_17.m b/lib/t/t_most_30b_1_1_17.m index befd046..37428e3 100644 --- a/lib/t/t_most_30b_1_1_17.m +++ b/lib/t/t_most_30b_1_1_17.m @@ -1,8 +1,8 @@ function t_most_30b_1_1_17(quiet) -%T_MOST_30B_1_1_17 Tests for MOST. +% t_most_30b_1_1_17 - Tests for MOST, 30-bus, 1 period, 17 contingencies. % MOST -% Copyright (c) 2009-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2009-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_30b_3_1_0.m b/lib/t/t_most_30b_3_1_0.m index 24366d3..484aec7 100644 --- a/lib/t/t_most_30b_3_1_0.m +++ b/lib/t/t_most_30b_3_1_0.m @@ -1,8 +1,8 @@ function t_most_30b_3_1_0(quiet) -%T_MOST_30B_3_1_0 Tests for MOST. +% t_most_30b_3_1_0 - Tests for MOST, 30-bus, 3 periods, no contingencies. % MOST -% Copyright (c) 2009-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2009-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_30b_3_1_17.m b/lib/t/t_most_30b_3_1_17.m index f39c72e..6c9010a 100644 --- a/lib/t/t_most_30b_3_1_17.m +++ b/lib/t/t_most_30b_3_1_17.m @@ -1,8 +1,8 @@ function t_most_30b_3_1_17(quiet) -%T_MOST_30B_3_1_17 Tests for MOST. +% t_most_30b_3_1_17 - Tests for MOST, 30-bus, 3 periods, 17 contingencies. % MOST -% Copyright (c) 2009-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2009-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_3b_1_1_0.m b/lib/t/t_most_3b_1_1_0.m index abd2bb3..6b5ce87 100644 --- a/lib/t/t_most_3b_1_1_0.m +++ b/lib/t/t_most_3b_1_1_0.m @@ -1,8 +1,8 @@ function t_most_3b_1_1_0(quiet) -%T_MOST_3B_1_1_0 Tests for MOST. +% t_most_3b_1_1_0 - Tests for MOST, 3-bus, 1 period, no contingencies. % MOST -% Copyright (c) 2009-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2009-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_3b_1_1_2.m b/lib/t/t_most_3b_1_1_2.m index 084e0f1..24a6918 100644 --- a/lib/t/t_most_3b_1_1_2.m +++ b/lib/t/t_most_3b_1_1_2.m @@ -1,8 +1,8 @@ function t_most_3b_1_1_2(quiet) -%T_MOST_3B_1_1_2 Tests for MOST. +% t_most_3b_1_1_2 - Tests for MOST, 3-bus, 1 period, 2 contingencies. % MOST -% Copyright (c) 2009-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2009-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_3b_3_1_0.m b/lib/t/t_most_3b_3_1_0.m index a7bb235..ee31717 100644 --- a/lib/t/t_most_3b_3_1_0.m +++ b/lib/t/t_most_3b_3_1_0.m @@ -1,8 +1,8 @@ function t_most_3b_3_1_0(quiet) -%T_MOST_3B_3_1_0 Tests for MOST. +% t_most_3b_3_1_0 - Tests for MOST, 3-bus, 3 periods, no contingencies. % MOST -% Copyright (c) 2009-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2009-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_3b_3_1_2.m b/lib/t/t_most_3b_3_1_2.m index d57998c..076684a 100644 --- a/lib/t/t_most_3b_3_1_2.m +++ b/lib/t/t_most_3b_3_1_2.m @@ -1,8 +1,8 @@ function result = t_most_3b_3_1_2(quiet) -%T_MOST_3B_1_1_2 Tests for MOST. +% t_most_3b_3_1_2 - Tests for MOST, 3-bus, 3 periods, 2 contingencies. % MOST -% Copyright (c) 2009-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2009-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_fixed_res.m b/lib/t/t_most_fixed_res.m index 7461893..229e4fa 100644 --- a/lib/t/t_most_fixed_res.m +++ b/lib/t/t_most_fixed_res.m @@ -1,8 +1,8 @@ function t_most_fixed_res(quiet) -%T_MOST_FIXED_RES Tests MOST with fixed reserve requirements. +% t_most_fixed_res - Tests MOST with fixed reserve requirements. % MOST -% Copyright (c) 2012-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2012-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_mpopf.m b/lib/t/t_most_mpopf.m index 508d994..b8e4d4d 100644 --- a/lib/t/t_most_mpopf.m +++ b/lib/t/t_most_mpopf.m @@ -1,10 +1,10 @@ function t_most_mpopf(quiet) -%T_MOST_MPOPF Tests of deterministic multiperiod DC OPF problems +% t_most_mpopf - Tests of deterministic multiperiod DC OPF problems % -% Cases taken from most_ex5_mpopf.m. +% Cases taken from most_ex5_mpopf. % MOST -% Copyright (c) 2015-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_sp.m b/lib/t/t_most_sp.m index 6bb4885..f0fd8a0 100644 --- a/lib/t/t_most_sp.m +++ b/lib/t/t_most_sp.m @@ -1,5 +1,6 @@ function t_most_sp(quiet, create_plots, create_pdfs, savedir) -%T_MOST_SP Tests of single-period continuous optimizations +% t_most_sp - Tests of single-period continuous optimizations +% :: % % T_MOST_SP(QUIET, CREATE_PLOTS, CREATE_PDFS, SAVEDIR) % Can generate summary plots and save them as PDFs in a directory of @@ -7,7 +8,7 @@ function t_most_sp(quiet, create_plots, create_pdfs, savedir) % E.g. t_most_sp(0, 1, 1, '~/Downloads/sp_plots') % MOST -% Copyright (c) 2015-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_spuc.m b/lib/t/t_most_spuc.m index 5093155..33af613 100644 --- a/lib/t/t_most_spuc.m +++ b/lib/t/t_most_spuc.m @@ -1,5 +1,6 @@ function t_most_spuc(quiet, create_plots, create_pdfs, savedir) -%T_MOST_SPUC Tests of single-period unit commitment optimizations +% t_most_spuc - Tests of single-period unit commitment optimizations +% :: % % T_MOST_SPUC(QUIET, CREATE_PLOTS, CREATE_PDFS, SAVEDIR) % Can generate summary plots and save them as PDFs in a directory of @@ -7,7 +8,7 @@ function t_most_spuc(quiet, create_plots, create_pdfs, savedir) % E.g. t_most_spuc(0, 1, 1, '~/Downloads/spuc_plots') % MOST -% Copyright (c) 2015-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_suc.m b/lib/t/t_most_suc.m index 873989e..41994b6 100644 --- a/lib/t/t_most_suc.m +++ b/lib/t/t_most_suc.m @@ -1,5 +1,6 @@ function t_most_suc(quiet, create_plots, create_pdfs, savedir) -%T_MOST_SUC Tests of stochastic unit commitment optimizations. +% t_most_suc - Tests of stochastic unit commitment optimizations. +% :: % % T_MOST_SUC(QUIET, CREATE_PLOTS, CREATE_PDFS, SAVEDIR) % Can generate summary plots and save them as PDFs in a directory of @@ -7,7 +8,7 @@ function t_most_suc(quiet, create_plots, create_pdfs, savedir) % E.g. t_most_suc(0, 1, 1, '~/Downloads/suc_plots') % MOST -% Copyright (c) 2015-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_tlmp.m b/lib/t/t_most_tlmp.m index 683e3f9..742776e 100644 --- a/lib/t/t_most_tlmp.m +++ b/lib/t/t_most_tlmp.m @@ -1,8 +1,8 @@ function t_most_tlmp(quiet) -%T_MOST_TLMP Tests of TLMP for ramping and storage +% t_most_tlmp - Tests of TLMP for ramping and storage % MOST -% Copyright (c) 2022, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2022-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_uc.m b/lib/t/t_most_uc.m index 0a8507a..0a3778d 100644 --- a/lib/t/t_most_uc.m +++ b/lib/t/t_most_uc.m @@ -1,5 +1,6 @@ function t_most_uc(quiet, create_plots, create_pdfs, savedir) -%T_MOST_UC Tests of deteministic unit commitment optimizations +% t_most_uc - Tests of deteministic unit commitment optimizations +% :: % % T_MOST_UC(QUIET, CREATE_PLOTS, CREATE_PDFS, SAVEDIR) % Can generate summary plots and save them as PDFs in a directory of @@ -7,7 +8,7 @@ function t_most_uc(quiet, create_plots, create_pdfs, savedir) % E.g. t_most_uc(0, 1, 1, '~/Downloads/uc_plots') % MOST -% Copyright (c) 2015-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/t_most_w_ds.m b/lib/t/t_most_w_ds.m index e5ffe44..1947dc5 100644 --- a/lib/t/t_most_w_ds.m +++ b/lib/t/t_most_w_ds.m @@ -1,8 +1,8 @@ function t_most_w_ds(quiet, solver, verbose) -%T_MOST_W_DS Test for MOST with dynamical system constraints. +% t_most_w_ds - Test for MOST with dynamical system constraints. % MOST -% Copyright (c) 2015-2020, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2015-2024, Power Systems Engineering Research Center (PSERC) % by Carlos E. Murillo-Sanchez, PSERC Cornell & Universidad Nacional de Colombia % and Ray Zimmerman, PSERC Cornell % diff --git a/lib/t/test_most.m b/lib/t/test_most.m index db0df5b..a703101 100644 --- a/lib/t/test_most.m +++ b/lib/t/test_most.m @@ -1,19 +1,21 @@ function success = test_most(verbose, exit_on_fail) -%TEST_MOST Run all MOST tests. -% TEST_MOST -% TEST_MOST(VERBOSE) -% TEST_MOST(VERBOSE, EXIT_ON_FAIL) -% SUCCESS = TEST_MOST(...) +% test_most - Run all MOST tests. +% :: % -% Runs all of the MOST tests. If VERBOSE is true (false by default), -% it prints the details of the individual tests. If EXIT_ON_FAIL is true -% (false by default), it will exit MATLAB or Octave with a status of 1 -% unless T_RUN_TESTS returns ALL_OK. +% test_most +% test_most(verbose) +% test_most(verbose, exit_on_fail) +% success = test_most(...) % -% See also T_RUN_TESTS. +% Runs all of the MOST tests. If ``verbose`` is true *(false by default)*, +% it prints the details of the individual tests. If ``exit_on_fail`` is true +% *(false by default)*, it will exit MATLAB or Octave with a status of 1 +% unless t_run_tests returns ``all_ok`` true. +% +% See also t_run_tests. % MOST -% Copyright (c) 2004-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2004-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST. diff --git a/lib/t/uniformwindprofile.m b/lib/t/uniformwindprofile.m index bca562d..23b1a4a 100644 --- a/lib/t/uniformwindprofile.m +++ b/lib/t/uniformwindprofile.m @@ -1,5 +1,6 @@ function profiles = uniformwindprofile(nt, nj, n) -%UNIFORMWINDPROFILE Creates a wind profile with evenly spaced capacity values. +% uniformwindprofile - Creates a wind profile with evenly spaced capacity values. +% :: % % PROFILES = UNIFORMWINDPROFILE(NT, NJ, N) % @@ -8,10 +9,10 @@ % factors are evenly spaced from 0 to 1. All inputs are optional. % Defaults are NT = 24, NJ = 5, N = 1. % -% See also IDX_PROFILE, GET_PROFILES. +% See also idx_profile, getprofiles. % MOST -% Copyright (c) 2013-2016, Power Systems Engineering Research Center (PSERC) +% Copyright (c) 2013-2024, Power Systems Engineering Research Center (PSERC) % by Ray Zimmerman, PSERC Cornell % % This file is part of MOST.