The tasks of coding part can be found in the git histroy in different branches.
Branch aims at testing the code by different developers, after getting a convinced result and confirmed by the team and clients, the results will be merged to master branch
The research tasks are logged in Tasks and Contributions
-
PySWMM:Coupled system to simulate the water in pipe system, written by Python, including all interface to SWMM.
-
SWMM: Simulate water in pipe system, written by C, including coupling method in branch "feature-2dflood".
-
ANUGA-Viewer: Visulization tool to observe the flood, written by C++.
- Overview
- Team
- Stakeholders
- Documentation
- Timeline
- Risks
- Tools and Client Requirements
- Technical Constraints
- Tasks and contributions
- Relevant Repo
- Handover
The existing ANUGA Hydro software has been used to model floods for more than a decade, with excellent results. But for smaller floods, it has a tendency to over estimate the flood area, due to being unable to model underground drainage systems.
This project will extend the ANUGA Hydro software, which is capable of hydrodynamic modelling, by coupling with the US EPA's Storm Water Management Model (SWMM), thus adding to it the ability to model the effects of underground drainage systems.
| Name | UID | Principal Role | Secondary Role |
|---|---|---|---|
| Zheyuan Zhang | u6870923 | ANUGA developer ANUGA Viewer supporter |
Documentation (grammar) reviewer Code reviewer (ANUGA & SWMM) |
| Xingnan Pan | u6744662 | ANUGA developer client manager |
Test developer Code reviewer (ANUGA & SWMM) Minutes taker |
| Chen Huang | u6735118 | SWMM developer Spokesperson |
Code reviewer (ANUGA) Landing page maintainer Minutes taker |
| Lixin Hou | u6456457 | ANUGA developer ANUGA tester Deputy spokesperson Client Manager |
Document author Minutes taker |
| Mingda Zheng | u6686733 | SWMM developer Quality manager |
Code reviewer (SWMM&ANUGA) Test developer |
| Yijie Liu | u6890141 | ANUGA developer Quality manager |
Test developer Documentation author |
| Zijun Zhang | u6904534 | SWMM developer Documentation author |
Code reviewer (ANUGA) |
| Zhixian Wu (Past member, graduated) | u5807060 |
- The sponsors:
- Professor Stephen Roberts, ANU
- Dr Ole Nielsen, Geoscience Australia
- The user representatives (flood modellers):
- Rudy Van Drie, Balance Research and Development
- Dr Petar Milevski, Civil Engineer Urban Drainage, Wollongong City Council
Zoom
2020 meeting minutes
Sprint 1 (start of semester - 19/08/2020)
Sprint 2 (19/08/2020 - 02/09/2020)
Sprint 3 (02/09/2020 - 16/09/2020)
Sprint 4 (16/09/2020 - 30/09/2020)
Sprint 5 (30/09/2020 - 14/10/2020)
2021 meeting minutes
Sprint 1 (start of semester - 10/03/2021)
Sprint 2 (11/03/2021 - 31/03/2021)
Sprint 3 (31/03/2021 - 14/04/2021)
Sprint 4 (14/04/2021 - 28/04/2021)
Sprint 5 (28/04/2021 - 12/05/2021)
2020 reflection
2021 reflection
- Small decision log
- Details of large decisions
We are doing two-week sprints, with client meetings to close each sprint on Wednesday 5:00PM Canberra time, and team meetings for sprint retrospectives and sprint planning on Wednesday 7:00PM Canberra time.
The first sprint will be a bit longer, so that the rest of the sprints will end just before the Week 6 and Week 10 audits. This means the first sprint will end Wednesday of Week 4.
- 2020-s2-timeline
- 2021-s1-timeline
- 2021-s1-milestone
| Risk ID | Risk points | Mitigation measures |
|---|---|---|
| 1 | The new member may take a long time to learn the complex model and tools needs. | He would be given one to two weeks to get familiar with our project. Also, Other members would give him instructions and advise about the project. In addition, the clients are the original developers of the software and the team can ask them questions. |
| 2 | Team members may have some emergencies during the project, such as sick, exam which may interrupt the project progress. | We will never have any task that is only performed by one team member. Either the task will be performed by a small group, or if it is too small one team member will be assigned as the secondary person responsible for reviewing the code and taking over if the member principally responsible has an emergency situation |
| 3 | The time difference might be a cooperation barrier as the team consists of overseas and native members. | Most members are living in China, which merely has 2-3 hours lag with the Australian Eastern Standard Time. Therefore, the team or client meeting can be set at afternoon to mitigate the impact. |
| 4 | The system and equipment requirements may cause some difficulties to the team, as the project is required to design in Ubuntu 20.04, but some features can only run in Ubuntu 18.04. | Members can use virtual machine or install dual systems to have mathcing development environments. And some complex issues can be tested in lab machines by members in Canberra. |
- The project should be developed in Github
- Each member is able to test in a branch
- Using pull request to get the task review from others
- Only tested and review code should be merged into the
mainbranch
- The project is mainly developed on Ubuntu 20.04
- This means that team members will need to install a virtual machine or dual boot. All members have already done so.
- Setup Continuous Integration (CI) tools to test on three platforms (Windows, MacOS and Ubuntu) automatically.
- This was a Sprint 1 task for two members of the team. They have already set up Appveyor and TravisCI to handle this.
- Software standards
- The Python code should follow the PEP8 standard apart from agreed exceptions.
- All code, apart from the most trivial, should have corresponding unit tests.
- Model behaviour should be tested end to end with real data.
- Tests should be integrated with a CI server.
- The standard official version of SWMM from the US EPA website is only available for Windows, so we will use another open-source project called PySWMM by Open Water Analytics.
The end modelling software must be a coupling between ANUGA and SWMM. There are no other open-source options for this type of software. And even if there were, the team was commissioned by the clients to improve the existing ANUGA Hydro software in a specific way.
The handover document contains all the important information and instruction links about the project.
