Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
114 lines (67 sloc) 3.39 KB

SUEWS: Surface Urban Energy and Water Balance Scheme

Documentation Status
  • How to get SUEWS?

    • Latest release:

      The latest formal release of SUEWS is new_latest and can be downloaded via our Zenodo repository (a sample input dataset is included in the release archive).

    • Previous releases:

      Previous releases can be downloaded via our GitHub page.

  • How to use SUEWS?

    • For existing users:

    Overview of changes in this version, see :ref:`new_latest`. If these changes impact your existing simulations, please see appropriate parts of the manual. It may be necessary to adapt some of your input files for for the current version.

    Tip

    A helper python script, SUEWS table converter <input_converter>, is provided to help facilitate the conversion of input files between different SUEWS versions.

    Additionally, the manuals for previous versions can be accessed in respective sections under version_history.

    • For new users:

    Before performing SUEWS simulations, new users should read the overview :ref:`introduction`, then follow the steps in Preparing_to_run_the_model to prepare input files <input_files> for SUEWS.

    Note there are tutorials learning about running SUEWS available :ref:`the tutorial. <tutorials_suews>`

  • How has SUEWS been used?

The scientific details and application examples of SUEWS can be found in Recent_publications.
  • How to cite SUEWS?

    Tip

    Visit the repositories below for different citation styles.

    • Software:

      Sun Ting, Järvi Leena, Grimmond Sue, Lindberg Fredrik, Li Zhenkun, Tang Yihao, Ward Helen: (2019, February 21). SUEWS: Surface Urban Energy and Water Balance Scheme (Version 2018c). Zenodo. doi_software

    • Manual:

      Sun Ting, Järvi Leena, Grimmond Sue, Lindberg Fredrik, Li Zhenkun, Tang Yihao, Ward Helen: (2019, February 21). SUEWS Documentation (Version 2018c). Zenodo. doi_docs

  • How to support SUEWS?

    1. Cite SUEWS <cite_suews> appropriately in your work.
    2. Contribute to the development <Development_Suggestions_Support>.
    3. Report issues via the `GitHub page`_.
    4. Provide suggestions and feedback <Development_Suggestions_Support>.
.. toctree::
   :maxdepth: 2
   :numbered:
   :hidden:

   introduction
   parameterisations-and-sub-models
   prepare-to-run-the-model
   input_files/input_files
   output_files/output_files
   troubleshooting
   recent-publications
   related_softwares
   sub-tutorials/tutorials
   development/development
   benchmark/benchmark_report
   api
   version-history/version-history
   acknowledgement
   notation
   references
You can’t perform that action at this time.