From 9388416f549fccefb10227c3f2ca0521760cd60b Mon Sep 17 00:00:00 2001 From: Ting Sun Date: Sun, 10 Aug 2025 09:24:44 +0100 Subject: [PATCH] docs: remove outdated content and fix inaccuracies - Removed 5 stale UMEP HTML files from docs/source/images/ - Fixed outdated YAML API comment in workflow.rst (fully functional, not in development) - Added reference to issue #581 for pending table-to-YAML conversion - Removed deprecated warning from README.md developer section --- README.md | 3 - docs/source/images/File_LCZdialog1.htm | 233 ------------------ docs/source/images/File_SEBE_noVeg.htm | 204 --------------- docs/source/images/File_SuewsAdvanced.htm | 0 .../File_SuewsAdvanced.htm.8wjizt1.partial | 213 ---------------- docs/source/images/File_SuewsSimple.htm | 212 ---------------- docs/source/workflow.rst | 10 +- 7 files changed, 5 insertions(+), 870 deletions(-) delete mode 100644 docs/source/images/File_LCZdialog1.htm delete mode 100644 docs/source/images/File_SEBE_noVeg.htm delete mode 100644 docs/source/images/File_SuewsAdvanced.htm delete mode 100644 docs/source/images/File_SuewsAdvanced.htm.8wjizt1.partial delete mode 100644 docs/source/images/File_SuewsSimple.htm diff --git a/README.md b/README.md index 7d168664d..5a26d8310 100644 --- a/README.md +++ b/README.md @@ -35,9 +35,6 @@ For developers, see the [Developer Note](#developer-note) section below. ## Developer Note -> [!NOTE] -> **the following is deprecated and will be updated** - ### Development Environment #### Claude Code Integration diff --git a/docs/source/images/File_LCZdialog1.htm b/docs/source/images/File_LCZdialog1.htm deleted file mode 100644 index df5ac6907..000000000 --- a/docs/source/images/File_LCZdialog1.htm +++ /dev/null @@ -1,233 +0,0 @@ - - - - -File:LCZdialog1.png - UMEP - - - - - - - - - - - - - - - - -
-
-
- - -
-
-

File:LCZdialog1.png

-
-
来自UMEP
-
-
- 跳转至： 导航、 搜索 -
-
-
原始文件 ‎（1,702 × 1,104像素，文件大小：112 KB，MIME类型：image/png） -
-

LCZ dialog for pervious surface distribution specified for each LCZ. -

- - - - - -

文件历史

-
-

单击某个日期/时间查看对应时刻的文件。 -

- - - - -
日期/时间缩略图大小用户备注
当前2017年3月2日 (四) 15:562017年3月2日 (四) 15:56的版本的缩略图1,702 × 1,104（112 KB）NatalieT（讨论 | 贡献）
恢复2017年3月1日 (三) 16:022017年3月1日 (三) 16:02的版本的缩略图1,698 × 1,100（151 KB）NatalieT（讨论 | 贡献）LCZ dialog for pervious surface distribution specified for each LCZ.
- -
- - -
-

以下2个页面链接至本文件： -

-
-

元数据

-
此文件中包含有扩展的信息。这些信息可能是由数码相机或扫描仪在创建或数字化过程中所添加的。 -如果此文件的源文件已经被修改，一些信息在修改后的文件中将不能完全反映出来。 - - - - - - - - - - - - -
图像宽度1,104 px
图像高度1,702 px
水平分辨率56.69 dpc
垂直分辨率56.69 dpc
-
-
- 取自“http://urban-climate.net/umep/index.php?title=File:LCZdialog1.png&oldid=4382”
-
-
-
-
-

导航菜单

- -
- -
- - -
-
- - - -
-
-
- - - - - -
-
- - - - - - diff --git a/docs/source/images/File_SEBE_noVeg.htm b/docs/source/images/File_SEBE_noVeg.htm deleted file mode 100644 index 7fd9cea65..000000000 --- a/docs/source/images/File_SEBE_noVeg.htm +++ /dev/null @@ -1,204 +0,0 @@ - - - - -File:SEBE noVeg.png - UMEP - - - - - - - - - - - - - - -
-
-
- - -
-
-

File:SEBE noVeg.png

-
-
From UMEP
-
-
- Jump to: navigation, search -
-
-
SEBE_noVeg.png ‎(364 × 340 pixels, file size: 68 KB, MIME type: image/png) -
-
- - - - - -

File history

-
-

Click on a date/time to view the file as it appeared at that time. -

- - - -
Date/TimeThumbnailDimensionsUserComment
current13:15, 23 October 2016Thumbnail for version as of 13:15, 23 October 2016364 × 340 (68 KB)SueGrimmond (Talk | contribs)
- -
-
    -
  • You cannot overwrite this file.
    • -
- -
-

The following page links to this file: -

-
-
- Retrieved from "http://www.urban-climate.net/umep/index.php?title=File:SEBE_noVeg.png&oldid=3210"
-
-
-
-
-

Navigation menu

- -
- -
- - -
-
- - - -
-
-
- - - - - -
-
- - - - - - - diff --git a/docs/source/images/File_SuewsAdvanced.htm b/docs/source/images/File_SuewsAdvanced.htm deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/source/images/File_SuewsAdvanced.htm.8wjizt1.partial b/docs/source/images/File_SuewsAdvanced.htm.8wjizt1.partial deleted file mode 100644 index 256ff222d..000000000 --- a/docs/source/images/File_SuewsAdvanced.htm.8wjizt1.partial +++ /dev/null @@ -1,213 +0,0 @@ - - - - -File:SuewsAdvanced.png - UMEP - - - - - - - - - - - - - - - - -
-
-
- - -
-
-

File:SuewsAdvanced.png

-
-
来自UMEP
-
-
- 跳转至： 导航、 搜索 -
-
-
原始文件 ‎（474 × 613像素，文件大小：39 KB，MIME类型：image/png） -
-
- - - - - -

文件历史

-
-

单击某个日期/时间查看对应时刻的文件。 -

- - - -
日期/时间缩略图大小用户备注
当前2017年10月2日 (一) 15:262017年10月2日 (一) 15:26的版本的缩略图474 × 613（39 KB）Fredrik（讨论 | 贡献）
- -
- - -
-

以下2个页面链接至本文件： -

-
-
- 取自“http://urban-climate.net/umep/index.php?title=File:SuewsAdvanced.png&oldid=5430”
-
-
-
-
-

导航菜单

- -
- -
- - -
-
- - - -
-
-
- - - - - -
-
- - - - - - diff --git a/docs/source/images/File_SuewsSimple.htm b/docs/source/images/File_SuewsSimple.htm deleted file mode 100644 index d62af0d32..000000000 --- a/docs/source/images/File_SuewsSimple.htm +++ /dev/null @@ -1,212 +0,0 @@ - - - - -File:SuewsSimple.png - UMEP - - - - - - - - - - - - - - - - -
-
-
- - -
-
-

File:SuewsSimple.png

-
-
来自UMEP
-
-
- 跳转至： 导航、 搜索 -
-
-
原始文件 ‎（1,109 × 692像素，文件大小：69 KB，MIME类型：image/png） -
-
- - - - - -

文件历史

-
-

单击某个日期/时间查看对应时刻的文件。 -

- - - -
日期/时间缩略图大小用户备注
当前2017年2月10日 (五) 14:492017年2月10日 (五) 14:49的版本的缩略图1,109 × 692（69 KB）Fredrik（讨论 | 贡献）
- -
- - -
-

以下1个页面链接至本文件： -

-
-
- 取自“http://urban-climate.net/umep/index.php?title=File:SuewsSimple.png&oldid=4327”
-
-
-
-
-

导航菜单

- -
- -
- - -
-
- - - -
-
-
- - - - - -
-
- - - - - - diff --git a/docs/source/workflow.rst b/docs/source/workflow.rst index 3dc87d414..772dcfdc1 100644 --- a/docs/source/workflow.rst +++ b/docs/source/workflow.rst @@ -280,8 +280,8 @@ Once you have a YAML configuration file, you can use either the traditional func import supy as sp - # Note: Direct YAML loading in functional API is in development - # For now, use sample data or legacy table-based inputs + # The functional API uses DataFrames for configuration + # YAML loading is available through the SUEWSSimulation class (see above) df_state_init, df_forcing = sp.load_sample_data() # Start with sample data # Then modify parameters as needed using pandas operations @@ -506,11 +506,11 @@ Migration Process .. code-block:: bash - # Convert legacy table inputs to modern YAML + # Convert legacy table inputs to modern YAML (pending issue #581) suews-convert to-yaml -i legacy_input_dir/ -o modern_config.yml - # Validate converted configuration - supy-validate modern_config.yml + # Note: This feature is under development (see issue #581) + # For now, use the SUEWSSimulation class with existing table inputs or YAML files **Testing Your Migration:**