Getting Started

Registration

SwirlsPy, the codebase of Com-SWIRLS, is freely shared with all National Meteorological and Hydrological Services (NMHS), as listed on this page.

If you work in an NMHS, please register through this link, then send an email to swirls@hko.gov.hk with the following information:

  • The username specified during registration
  • Your Full Name, with Family/Last Name capitalised
  • Your Organisation (must be a NMHS or a subsidary, branch/division, regional/local office etc.)
  • Your Position (e.g. Administrator, Scientific Officer, Programmer etc.)

Please use your official email address (ending with a domain name same as any NMHS) to send the above email, as it helps us establish your identity expeditiously. In case you have no official email address, please still send us a request and we will strive to establish your identity through other means.

If you do not work in an NMHS but actively collaborate with someone who works in an NMHS, please register and then ask your collaborator to send us an email to request access to Com-SWIRLS for you. We will flexibly handle such requests on case-by-case basis.

Request for permission to access the project will typically be processed within a few days.

Installation

Com-SWIRLS/SwirlsPy is distributed as a Conda package and can be installed with an one-line command. Detailed instructions are provided on the README document, which shows up on the first page after sign-in.

Contact

Please feel free to contact us if you have any question.