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.
Accounts registered with official email addresses (carrying a domain name same as any NMHS) will be given permission to access the project com-swirls within a couple of days.
If you do not have an official email address but work in a NMHS, please register and then send an email to swirls@hko.gov.hk with the following information:
- 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.)
- The username specified during registration
Request for permission to access the project will be reviewed and normally processed within one week.
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.