Architecture and UX sub-group meeting on 2025-01-24 at 08:00 AEST

[carlhiggs]

Attendees: @carlhiggs (chair), @eugenrb , @gboeing , @rschifan and @shiqin-liu

GHSCI software UI, UX, architecture and development rethinking

We formed a new sub-group @healthysustainablecities/ghsci-architecture-and-ux-working-group to develop a plan to refresh our software and address several core issues, which we discussed:

Configuration

Configuration can be complex for users (despite recent efforts #497) and we agreed that we should re-approach this using a standardised schema (@carlhiggs action #506 ), that in future could more easily support use in multiple formats (including as a GUI, notwithstanding current draft GUI implementation as described in #414 --- this could be integrated in the GHSCI app as a short term measure). This relates to #472.

Dependencies

One of the complexities of our project that constrains how we package our software is our reliance on various dependencies, including the use of a spatial database. There are good historical reasons for this approach, but to help simplify both our software stack and code it is worth re-thinking the approach to data management (#507) and exploring the pros and cons of various scenarios in terms of robustness but also performance.

Modularity

Currently the implementation of the GHSCI app and its documentation is closely tied to the code process. There could be more separation. This might ideally involve a rethinking of the overall monolithic project architecture, that could be reapproached using microservices for different tasks. A redesign in this way could help with delivery of software (i.e. people install and use what they need to use), and make it easier to document --- with separation between the various parts of the software.

Software folder structure

From a user perspective, the current project structure may not be intuitive. There are multiple seperate folders to traverse, within the process directory, for users to configure, store input data and retrieve output data. Ideally, region configuration and data inputs/outputs would be the main folders viewable for users; with the current approach, they have to deal with code and program logic that doesn't concern them to get to these, which may be a barrier. It would be good to rethink how the software is structured from a user perspective to keep program logic very seperate to inputs and outputs. It currently is in a sense (there are separate folders for configuration and data) --- but the program logic should not be visible to those who don't want to deal with it.

Previewing indicators

It could be more straightforward for users to preview indicators on a map. Currently there is a function to produce a choropleth plot (#344, demonstrated in Jupyter notebook example and implemented in the GHSCI app #409, but could be improved), and there are suggestions for how users could explore results using their Desktop GIS in addition to reviewing the analysis report and draft indicators reports. However, a comprehensive dashboard would be nice to have.

Next steps

• We agreed the first priority is standardising configuration; I will draft a standardised schema to share in the coming weeks (Implement schema for current configuration file #506).
• Seperately @carlhiggs and @gboeing discussed how we could benchmark and monitor performance of software under various operating scenarios as it is currently, and potentially using alternate approaches for data management (e.g. read/write from Geopackage, in particular using GeoArrow specification; but potentially other approaches) --- @ruoyuch may be available and interested to assist with this as per Alternative approaches to data management to simplify our dependencies and streamline our code #507. This exploration could support reduction in dependencies, streamling both our software stack and code.
• Rather than more meetings for this sub-group, we will engage on these priorities through Github and the monthly GHSCI Software working group meetings; we can report on the above aspects as standing agenda items.
• @shiqin-liu indicated she is happy to assist with code review in future; we agreed in future that pull requests should be reviewed before merging in addition to testing
• I set up a project board with a timeline specifically focused on Architectecture and UX: https://github.com/orgs/healthysustainablecities/projects/1

[carlhiggs]

@healthysustainablecities/ghsci-architecture-and-ux-working-group --- also wanted to say, if any of you want to be more actively involved in any of the above tasks, or propose tasks in line with your own interests, please do! Contributions to improve the software are more than welcome from all. An ideal outcome of the efforts of our subgroup will be to make the software leaner and more approachable for others to contribute to. And @eugenrb you mentioned @agrptec might be interested too --- if you have an interest in any of these things, including assisting with #506 please let us know. Contributions are welcome :)

[eugenrb]

Adding the notes from Fred (Fireflies.ai)
[https://app.fireflies.ai/view/GHSCI-software-UI-UX-architecture-and-development-rethinking::O5UZk79CnMx5Jmtr]

Overview
The software planning and review meeting focused on rethinking the interface, user experience and software architecture of the GHSCI project. During the session, team responsibilities were reviewed and key issues were identified, such as software complexity and difficulties with YAML configuration. The current interface was presented and proposals for improvement were discussed, including the creation of a standard schema for configuration using JSON. Concrete actions were established, such as developing an alpha schema and an initial version of the web interface, with responsibilities assigned to Carl, Eugen and Rossano. In addition, it was agreed to continue work on the wiki and to improve code review.

Notes
Review of mission and responsibilities (00:13 - 10:14)
• Carl introduces meeting on rethinking interface, user experience and software architecture
• Geoff suggests reviewing the current mission and responsibilities of the project
• Dependence on external technologies and the need for simplification are discussed.

Identification of key issues (10:15 - 23:00)
• Geoff mentions that the software is hard to use and too large
• Rossano notes difficulties with YAML configuration and error handling
• Eugen highlights problems with YAML configuration file and project structure
• The need to better separate the software part and the web interface is discussed.

Demonstration of the current interface (23:00 - 34:20)
• Carl displays the current interface for configuration and error handling.
• The possibility of creating a web interface for configuration is discussed.
• Geoff suggests using Python data structures instead of YAML

� Suggested improvements (34:20 - 44:57)
• The creation of a standard scheme for configuration is discussed.
• Rossano suggests using JSON schema to automatically generate the interface.
• Carl shows a sketch of a graphical interface for configuration

Planning and next steps (45:07 - 53:35)
• It is agreed to create an alpha schematic and an alpha version of the web interface.
• Carl offers to work on the initial outline
• It was decided to include this topic in the monthly space team meetings.

Wiki discussion and code review (53:35 - 01:00:12)
• Eugen asks about the continuous work on the wiki
• It is agreed to continue working on the Jupyter lab part of the wiki.
• Shirley offers to help with code reviews.

Action items
Carl Higgs
• Create an alpha schema for the configuration based on the existing Python dictionary (52:33)
• Include Shirley as a reviewer in code extraction requests (57:40)
• Writing and posting meeting notes to the GitHub discussion board (59:27)

Eugen Resendiz
• Continue working on the Jupyter lab part of the wiki (56:28)

Rossano Schifanella
• Help with the schema-based part of the web interface (51:32)

Decisions
• It was agreed to create an alpha schematic and an initial version of the web interface.
• It was decided to use JSON schema to automatically generate the interface.
• It was established that Carl will work on the initial outline for the configuration.
• Shirley was included as a reviewer on code extraction requests.
• It was agreed to continue working on the Jupyter lab part of the wiki.

Ideas
• Carl Higgs proposes to rethink the interface, user experience and software architecture of the GHSCI project (00:13).
• Geoff suggests revising the current project mission and responsibilities to simplify the software (00:13).
• Rossano Schifanella mentions the difficulty with YAML configuration and error handling, suggesting the creation of a standard scheme for configuration (10:15, 34:20).
• Geoff suggests using Python data structures instead of YAML to improve usability (23:00).
• Carl Higgs presents a sketch of a graphical interface for the configuration (34:20).
• The possibility of creating a web interface for the configuration is discussed, with the support of
Rossano (23:00, 51:32).
• Eugen Resendiz proposes to continue working on the Jupyter lab part of the wiki (56:28).

Questions
• How will difficulties with YAML configuration be addressed in the software?
• What steps will be followed to implement the standard schema using JSON?
• How will the usability of the proposed new interface be measured?
• What resources will be needed to continue work on the wiki and code review?
• How will team members' suggestions be integrated into the development of the web interface?

[agrptec]

[like] Alan Gabriel Romero Pacheco reacted to your message:

…

________________________________ From: Carl Higgs ***@***.***> Sent: Friday, January 24, 2025 3:17:11 AM To: healthysustainablecities/global-indicators ***@***.***> Cc: Alan Gabriel Romero Pacheco ***@***.***>; Mention ***@***.***> Subject: Re: [healthysustainablecities/global-indicators] Architecture and UX sub-group meeting on 2025-01-24 at 08:00 AEST (Discussion #508) @healthysustainablecities/ghsci-architecture-and-ux-working-group<https://github.com/orgs/healthysustainablecities/teams/ghsci-architecture-and-ux-working-group> --- also wanted to say, if any of you want to be more actively involved in any of the above tasks, or propose tasks in line with your own interests, please do! Contributions to improve the software are more than welcome from all. And @eugenrb<https://github.com/eugenrb> you mentioned @agrptec<https://github.com/agrptec> might be interested too --- if you have an interest in any of these things, including assisting with #506<#506> please let us know. Contributions are welcome :) — Reply to this email directly, view it on GitHub<#508 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/A5NOZGCIQAU7JVVHQ6TY54T2MGWDPAVCNFSM6AAAAABVYUXVH6VHI2DSMVQWIX3LMV43URDJONRXK43TNFXW4Q3PNVWWK3TUHMYTCOJTG43DMOA>. You are receiving this because you were mentioned.Message ID: ***@***.***>