diff --git a/.flake8 b/.flake8 new file mode 100644 index 0000000..15a5dce --- /dev/null +++ b/.flake8 @@ -0,0 +1,3 @@ +[flake8] +# For black +max-line-length = 88 diff --git a/.gitignore b/.gitignore index 9f79fb2..2560c74 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,14 @@ # Python runtime files __pycache__ +.benchmarks +.pytest_cache + +# Python packaging +*.egg-info +dist/ + +# R runtime files +.Rhistory # Sphinx build outputs doc/_build diff --git a/README.md b/README.md deleted file mode 100644 index 03ec684..0000000 --- a/README.md +++ /dev/null @@ -1 +0,0 @@ -# message-ix-buildings \ No newline at end of file diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..2b9da9b --- /dev/null +++ b/README.rst @@ -0,0 +1,6 @@ +MESSAGEix-Buildings +******************* + +.. image:: https://readthedocs.com/projects/iiasa-energy-program-message-ix-buildings/badge/?version=latest + :target: https://docs.messageix.org/projects/buildings/en/latest/?badge=latest + :alt: Documentation status diff --git a/STURM_model/.Rhistory b/STURM_model/.Rhistory deleted file mode 100644 index e69de29..0000000 diff --git a/doc/conf.py b/doc/conf.py index 572b0db..8e0a5df 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -3,25 +3,31 @@ # For the full list of built-in configuration values, see the documentation: # https://www.sphinx-doc.org/en/master/usage/configuration.html -# -- Project information ----------------------------------------------------- +# -- Project information --------------------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information -project = 'MESSAGEix-Buildings' -copyright = '2023, IIASA ECE Program' -author = 'IIASA ECE Program' +project = "MESSAGEix-Buildings" +copyright = "2023, IIASA ECE Program" +author = "IIASA ECE Program" -# -- General configuration --------------------------------------------------- +# -- General configuration ------------------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration -extensions = [] +extensions = [ + "sphinx.ext.intersphinx", +] -templates_path = ['_templates'] -exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +# -- Options for HTML output ----------------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output +html_theme = "alabaster" +html_static_path = ["_static"] -# -- Options for HTML output ------------------------------------------------- -# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output +# -- Options for Sphinx.ext.intersphinx ------------------------------------------------ -html_theme = 'alabaster' -html_static_path = ['_static'] +intersphinx_mapping = { + "message_ix_models": ("https://docs.messageix.org/projects/models/en/stable", None), +} diff --git a/doc/dev.rst b/doc/dev.rst new file mode 100644 index 0000000..83792cb --- /dev/null +++ b/doc/dev.rst @@ -0,0 +1,36 @@ +Development +*********** + +Build the package +================= + +Ensure the Python package `build `__ is installed:: + + pip install build + +In the project base directory, run:: + + python -m build + +Build the documentation +======================= + +Change into the :file:`./doc/` directory:: + + cd doc + +Build (for instance) the HTML documentation:: + + make html + +The terminal output indicates “The HTML pages are in _build/html”. +Open the file :file:`index.html` in this directory. + +Write and run tests +=================== + +The :mod:`message_ix_buildings` package has some tests. + +Run these using `pytest `__:: + + pytest diff --git a/doc/index.rst b/doc/index.rst index 2ed7be1..31f16a0 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,13 +6,22 @@ Welcome to MESSAGEix-Buildings's documentation! =============================================== +“MESSAGEix-Buildings” refers to a collection of linked models, including: + +- ACCESS +- CHILLED +- :doc:`sturm` + +…and their integration with the :doc:`MESSAGEix-GLOBIOM model family `. + +At present, the package :mod:`message_ix_buildings` contains STURM only. + .. toctree:: :maxdepth: 2 - :caption: Contents: - - testing + :hidden: -Here is some description of MESSAGEix-Buildings. + sturm + dev Indices and tables ================== diff --git a/doc/sturm.rst b/doc/sturm.rst new file mode 100644 index 0000000..64ccac3 --- /dev/null +++ b/doc/sturm.rst @@ -0,0 +1,31 @@ +STURM +***** + +STURM is one model in the :doc:`MESSAGEix-Buildings ` framework. +It is primarily written in R. + +Usage and development +===================== + +One can use STURM via :mod:`message_ix_buildings` in any of the following ways: + +1. Install :mod:`message_ix_buildings`, for example:: + + pip install message-ix-buildings + + Locate the installation directory:: + + pip show message-ix-buildings + +2. Clone the repository from GitHub (https://github.com/iiasa/message-ix-buildings/), for example:: + + git clone git@github.com:iiasa/message-ix-buildings.git + + This creates a directory named :file:`message-ix-buildings`. + +In either case, all the STURM files are in a further subdirectory named :file:`./message_ix_buildings/sturm/`. +They are organized into 3 directories: + +- :file:`./data/` —input data. +- :file:`./model/` —R code. +- :file:`./output/` —example outputs. diff --git a/doc/testing.rst b/doc/testing.rst deleted file mode 100644 index a9d3425..0000000 --- a/doc/testing.rst +++ /dev/null @@ -1,6 +0,0 @@ -Testing -******* - -The :mod:`message_ix_buildings` package has some tests. - -Run these using ``pytest``. diff --git a/STURM_data/data_input_SSP2_EFC_LOWDEM_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_SSP2_EFC_LOWDEM_2100_comm.RData similarity index 100% rename from STURM_data/data_input_SSP2_EFC_LOWDEM_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_EFC_LOWDEM_2100_comm.RData diff --git a/STURM_data/data_input_SSP2_EFC_LOWDEM_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_SSP2_EFC_LOWDEM_2100_resid.RData similarity index 100% rename from STURM_data/data_input_SSP2_EFC_LOWDEM_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_EFC_LOWDEM_2100_resid.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-act-tec_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-act-tec_2100_comm.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-act-tec_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-act-tec_2100_comm.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-act-tec_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-act-tec_2100_resid.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-act-tec_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-act-tec_2100_resid.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-act_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-act_2100_comm.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-act_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-act_2100_comm.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-act_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-act_2100_resid.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-act_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-act_2100_resid.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-all_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-all_2100_comm.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-all_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-all_2100_comm.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-all_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-all_2100_resid.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-all_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-all_2100_resid.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-ele_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-ele_2100_comm.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-ele_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-ele_2100_comm.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-ele_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-ele_2100_resid.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-ele_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-ele_2100_resid.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-ref_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-ref_2100_comm.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-ref_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-ref_2100_comm.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-ref_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-ref_2100_resid.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-ref_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-ref_2100_resid.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-tec_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-tec_2100_comm.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-tec_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-tec_2100_comm.RData diff --git a/STURM_data/data_input_SSP2_NAV_Dem-NPi-tec_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-tec_2100_resid.RData similarity index 100% rename from STURM_data/data_input_SSP2_NAV_Dem-NPi-tec_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_NAV_Dem-NPi-tec_2100_resid.RData diff --git a/STURM_data/data_input_SSP2_SSP2_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_SSP2_SSP2_2100_comm.RData similarity index 100% rename from STURM_data/data_input_SSP2_SSP2_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_SSP2_2100_comm.RData diff --git a/STURM_data/data_input_SSP2_SSP2_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_SSP2_SSP2_2100_resid.RData similarity index 100% rename from STURM_data/data_input_SSP2_SSP2_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_SSP2_SSP2_2100_resid.RData diff --git a/STURM_data/data_input_nsp_SDP_EI-1p5C_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_EI-1p5C_2100_comm.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_EI-1p5C_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_EI-1p5C_2100_comm.RData diff --git a/STURM_data/data_input_nsp_SDP_EI-1p5C_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_EI-1p5C_2100_resid.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_EI-1p5C_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_EI-1p5C_2100_resid.RData diff --git a/STURM_data/data_input_nsp_SDP_EI-NPi_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_EI-NPi_2100_comm.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_EI-NPi_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_EI-NPi_2100_comm.RData diff --git a/STURM_data/data_input_nsp_SDP_EI-NPi_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_EI-NPi_2100_resid.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_EI-NPi_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_EI-NPi_2100_resid.RData diff --git a/STURM_data/data_input_nsp_SDP_MC-1p5C_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_MC-1p5C_2100_comm.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_MC-1p5C_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_MC-1p5C_2100_comm.RData diff --git a/STURM_data/data_input_nsp_SDP_MC-1p5C_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_MC-1p5C_2100_resid.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_MC-1p5C_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_MC-1p5C_2100_resid.RData diff --git a/STURM_data/data_input_nsp_SDP_MC-NPi_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_MC-NPi_2100_comm.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_MC-NPi_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_MC-NPi_2100_comm.RData diff --git a/STURM_data/data_input_nsp_SDP_MC-NPi_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_MC-NPi_2100_resid.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_MC-NPi_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_MC-NPi_2100_resid.RData diff --git a/STURM_data/data_input_nsp_SDP_RC-1p5C_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_RC-1p5C_2100_comm.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_RC-1p5C_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_RC-1p5C_2100_comm.RData diff --git a/STURM_data/data_input_nsp_SDP_RC-1p5C_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_RC-1p5C_2100_resid.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_RC-1p5C_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_RC-1p5C_2100_resid.RData diff --git a/STURM_data/data_input_nsp_SDP_RC-NPi_2100_comm.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_RC-NPi_2100_comm.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_RC-NPi_2100_comm.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_RC-NPi_2100_comm.RData diff --git a/STURM_data/data_input_nsp_SDP_RC-NPi_2100_resid.RData b/message_ix_buildings/sturm/data/data_input_nsp_SDP_RC-NPi_2100_resid.RData similarity index 100% rename from STURM_data/data_input_nsp_SDP_RC-NPi_2100_resid.RData rename to message_ix_buildings/sturm/data/data_input_nsp_SDP_RC-NPi_2100_resid.RData diff --git a/STURM_data/input_U_values.csv b/message_ix_buildings/sturm/data/input_U_values.csv similarity index 100% rename from STURM_data/input_U_values.csv rename to message_ix_buildings/sturm/data/input_U_values.csv diff --git a/STURM_data/input_prices.csv b/message_ix_buildings/sturm/data/input_prices.csv similarity index 100% rename from STURM_data/input_prices.csv rename to message_ix_buildings/sturm/data/input_prices.csv diff --git a/STURM_data/input_prices_R12.csv b/message_ix_buildings/sturm/data/input_prices_R12.csv similarity index 100% rename from STURM_data/input_prices_R12.csv rename to message_ix_buildings/sturm/data/input_prices_R12.csv diff --git a/STURM_data/prices_R12.csv b/message_ix_buildings/sturm/data/prices_R12.csv similarity index 100% rename from STURM_data/prices_R12.csv rename to message_ix_buildings/sturm/data/prices_R12.csv diff --git a/STURM_data/scenarios.csv b/message_ix_buildings/sturm/data/scenarios.csv similarity index 100% rename from STURM_data/scenarios.csv rename to message_ix_buildings/sturm/data/scenarios.csv diff --git a/STURM_model/B00_functions.R b/message_ix_buildings/sturm/model/B00_functions.R similarity index 100% rename from STURM_model/B00_functions.R rename to message_ix_buildings/sturm/model/B00_functions.R diff --git a/STURM_model/F02_init_stock_dyn_fut.R b/message_ix_buildings/sturm/model/F02_init_stock_dyn_fut.R similarity index 100% rename from STURM_model/F02_init_stock_dyn_fut.R rename to message_ix_buildings/sturm/model/F02_init_stock_dyn_fut.R diff --git a/STURM_model/F03_energy_demand.R b/message_ix_buildings/sturm/model/F03_energy_demand.R similarity index 100% rename from STURM_model/F03_energy_demand.R rename to message_ix_buildings/sturm/model/F03_energy_demand.R diff --git a/STURM_model/F04_constr_decision.R b/message_ix_buildings/sturm/model/F04_constr_decision.R similarity index 100% rename from STURM_model/F04_constr_decision.R rename to message_ix_buildings/sturm/model/F04_constr_decision.R diff --git a/STURM_model/F05_renov_switch_decision.R b/message_ix_buildings/sturm/model/F05_renov_switch_decision.R similarity index 100% rename from STURM_model/F05_renov_switch_decision.R rename to message_ix_buildings/sturm/model/F05_renov_switch_decision.R diff --git a/STURM_model/F06_stock_dyn_complete_rev.R b/message_ix_buildings/sturm/model/F06_stock_dyn_complete_rev.R similarity index 100% rename from STURM_model/F06_stock_dyn_complete_rev.R rename to message_ix_buildings/sturm/model/F06_stock_dyn_complete_rev.R diff --git a/STURM_model/F10_scenario_runs_MESSAGE_2100.R b/message_ix_buildings/sturm/model/F10_scenario_runs_MESSAGE_2100.R similarity index 100% rename from STURM_model/F10_scenario_runs_MESSAGE_2100.R rename to message_ix_buildings/sturm/model/F10_scenario_runs_MESSAGE_2100.R diff --git a/STURM_model/R00_report_basic.R b/message_ix_buildings/sturm/model/R00_report_basic.R similarity index 100% rename from STURM_model/R00_report_basic.R rename to message_ix_buildings/sturm/model/R00_report_basic.R diff --git a/STURM_model/R01_report_MESSAGE.R b/message_ix_buildings/sturm/model/R01_report_MESSAGE.R similarity index 100% rename from STURM_model/R01_report_MESSAGE.R rename to message_ix_buildings/sturm/model/R01_report_MESSAGE.R diff --git a/STURM_model/R02_report_IRP.R b/message_ix_buildings/sturm/model/R02_report_IRP.R similarity index 100% rename from STURM_model/R02_report_IRP.R rename to message_ix_buildings/sturm/model/R02_report_IRP.R diff --git a/STURM_model/R03_report_NGFS.R b/message_ix_buildings/sturm/model/R03_report_NGFS.R similarity index 100% rename from STURM_model/R03_report_NGFS.R rename to message_ix_buildings/sturm/model/R03_report_NGFS.R diff --git a/STURM_model/R05_report_NAVIGATE.R b/message_ix_buildings/sturm/model/R05_report_NAVIGATE.R similarity index 100% rename from STURM_model/R05_report_NAVIGATE.R rename to message_ix_buildings/sturm/model/R05_report_NAVIGATE.R diff --git a/STURM_model/S00_init_MESSAGE.R b/message_ix_buildings/sturm/model/S00_init_MESSAGE.R similarity index 100% rename from STURM_model/S00_init_MESSAGE.R rename to message_ix_buildings/sturm/model/S00_init_MESSAGE.R diff --git a/STURM_output/report_IRP_SSP2_2C_comm_R12.csv b/message_ix_buildings/sturm/output/report_IRP_SSP2_2C_comm_R12.csv similarity index 100% rename from STURM_output/report_IRP_SSP2_2C_comm_R12.csv rename to message_ix_buildings/sturm/output/report_IRP_SSP2_2C_comm_R12.csv diff --git a/STURM_output/report_IRP_SSP2_2C_resid_R12.csv b/message_ix_buildings/sturm/output/report_IRP_SSP2_2C_resid_R12.csv similarity index 100% rename from STURM_output/report_IRP_SSP2_2C_resid_R12.csv rename to message_ix_buildings/sturm/output/report_IRP_SSP2_2C_resid_R12.csv diff --git a/STURM_output/report_IRP_SSP2_BL_comm_R12.csv b/message_ix_buildings/sturm/output/report_IRP_SSP2_BL_comm_R12.csv similarity index 100% rename from STURM_output/report_IRP_SSP2_BL_comm_R12.csv rename to message_ix_buildings/sturm/output/report_IRP_SSP2_BL_comm_R12.csv diff --git a/STURM_output/report_IRP_SSP2_BL_resid_R12.csv b/message_ix_buildings/sturm/output/report_IRP_SSP2_BL_resid_R12.csv similarity index 100% rename from STURM_output/report_IRP_SSP2_BL_resid_R12.csv rename to message_ix_buildings/sturm/output/report_IRP_SSP2_BL_resid_R12.csv diff --git a/STURM_output/report_NGFS_SSP2_BL_comm_R12.csv b/message_ix_buildings/sturm/output/report_NGFS_SSP2_BL_comm_R12.csv similarity index 100% rename from STURM_output/report_NGFS_SSP2_BL_comm_R12.csv rename to message_ix_buildings/sturm/output/report_NGFS_SSP2_BL_comm_R12.csv diff --git a/STURM_output/report_NGFS_SSP2_BL_resid_R12.csv b/message_ix_buildings/sturm/output/report_NGFS_SSP2_BL_resid_R12.csv similarity index 100% rename from STURM_output/report_NGFS_SSP2_BL_resid_R12.csv rename to message_ix_buildings/sturm/output/report_NGFS_SSP2_BL_resid_R12.csv diff --git a/STURM_output/report_STURM_SSP2_BL_comm_R12_energy.csv b/message_ix_buildings/sturm/output/report_STURM_SSP2_BL_comm_R12_energy.csv similarity index 100% rename from STURM_output/report_STURM_SSP2_BL_comm_R12_energy.csv rename to message_ix_buildings/sturm/output/report_STURM_SSP2_BL_comm_R12_energy.csv diff --git a/STURM_output/report_STURM_SSP2_BL_comm_R12_material.csv b/message_ix_buildings/sturm/output/report_STURM_SSP2_BL_comm_R12_material.csv similarity index 100% rename from STURM_output/report_STURM_SSP2_BL_comm_R12_material.csv rename to message_ix_buildings/sturm/output/report_STURM_SSP2_BL_comm_R12_material.csv diff --git a/STURM_output/report_STURM_SSP2_BL_resid_R12_energy.csv b/message_ix_buildings/sturm/output/report_STURM_SSP2_BL_resid_R12_energy.csv similarity index 100% rename from STURM_output/report_STURM_SSP2_BL_resid_R12_energy.csv rename to message_ix_buildings/sturm/output/report_STURM_SSP2_BL_resid_R12_energy.csv diff --git a/STURM_output/report_STURM_SSP2_BL_resid_R12_material.csv b/message_ix_buildings/sturm/output/report_STURM_SSP2_BL_resid_R12_material.csv similarity index 100% rename from STURM_output/report_STURM_SSP2_BL_resid_R12_material.csv rename to message_ix_buildings/sturm/output/report_STURM_SSP2_BL_resid_R12_material.csv diff --git a/run_STURM_offline.R b/message_ix_buildings/sturm/run_STURM_offline.R similarity index 100% rename from run_STURM_offline.R rename to message_ix_buildings/sturm/run_STURM_offline.R diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..47fc674 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,34 @@ +[build-system] +requires = ["build", "setuptools-scm"] + +[project] +dynamic = ["version"] +name = "message-ix-buildings" +authors = [ + {name = "IIASA ECE Program"} +] +maintainers = [ + {name = "Xiaoyang Zhong", email = "zhongx@iiasa.ac.at"}, + {name = "Alessio Mastrucci", email = "mastrucc@iiasa.ac.at"}, + {name = "Paul Natsuo Kishimoto", email = "kishimot@iiasa.ac.at"}, + {name = "Fridolin Glatter", email = "glatter@iiasa.ac.at"}, +] +readme = "README.rst" + +[project.urls] +homepage = "https://github.com/iiasa/message-ix-buildings" +repository = "https://github.com/iiasa/message-ix-buildings" +documentation = "https://docs.messageix.org/buildings/" + +[project.optional-dependencies] +docs = [ + "Sphinx", +] +tests = [ + "pytest", +] + +[tool.setuptools.packages] +find = {} + +[tool.setuptools_scm]