-
Notifications
You must be signed in to change notification settings - Fork 35
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Experience evaluation GHSCI v4.4.10 #375
Comments
Daria's comments cover most points well. I am adding some of my points here. My test is conducted on an Apple 2020 MacBook with an Intel i5 CPU, Intel Iris Plug Graphics (not an actual GPU), and 16 GB RAM. The MacOS version is Sonoma 14.0. General comments on the instructions
Web AppThe Web App is intuitive for me. The process is generally easy to follow. The "analysis" process took roughly 4~5 minutes on my computer for the Las Palmas example.
Jupyter LabThe Jupyter Lab is more useful in a sense of better flexibility. The "analysis" process took roughly 4~4.5 minutes on my computer for the Las Palmas example.
|
Hi, @carlhiggs we discussed the modifications proposed above with @gboeing and decided to proceed with the following tasks below. Some of them have solutions that are ready for pull requests, some will require more time. Let us know if you have any comments on that. A. Web App
B. Jupyter Lab and Software set up on GitHub:
C. Instructions on the website:
D. Docker Files @rychennn @dapugacheva
|
Hi @dapugacheva ,
Happy for you to trial these things. From memory, the multi platform
Docker build isn't straightforward --- previously had issues with this, but
it will be good to explore that so those with newer Apple chips like
yourself aren't disadvantaged. I drafted an updated Docker image in a new
branch but haven't had opportunity to test it extensively. It would be
good to work off that rather than main branch, and if you could confirm the
updated software packages work that would be great. Some newer versions of
Pandas introduce issues, and the GUI framework is frequently updated; the
new branch aims to update packages and code to deal with these things.
Eugen is still working on the updated report layout, so I think best to
leave enhancements branch on hold. I would consider working with a branch
off the newer one I created.
Hope this helps, and appreciate your work.
I'll be travelling for coming week so may not be in position to respond.
Cheers,
Carl
…On Thu, 15 Feb. 2024, 11:13 Daria Pugacheva, ***@***.***> wrote:
Hi, @carlhiggs <https://github.com/carlhiggs> we discussed the
modifications proposed above with @gboeing <https://github.com/gboeing>
and decided to proceed with the following tasks below. Some of them have
solutions that are ready for pull requests, some will require more time.
Let us know if you have any comments on that.
A. Web App
1.
Add instructions for the web app. There are three possible solutions:
a. Add instructions from the README file on the right side or/bottom
of the webpage (see image below).
Image
Screenshot.2024-02-09.at.5.27.32.PM.png (view on web)
<https://github.com/global-healthy-liveable-cities/global-indicators/assets/142947564/2c2f1024-b92a-4986-80ab-239a3ba7eadd>
b. Add pop-up floating windows as short comments for beginner users
for each step.
c. Do not add instructions to the web app. Instead, recommend having
multiple windows open with instructions on the left and a web app window on
the right to view both side-by-side.
@dapugacheva <https://github.com/dapugacheva> @rychennn
<https://github.com/rychennn>
2.
Create a "copy and paste" or "source linkage" button on the web app to
make it easier to download the .pdf report.
Add the mapping function to the web app. @rychennn
<https://github.com/rychennn>
3.
Add the mapping function to the web app. @rychennn
<https://github.com/rychennn> @dapugacheva
<https://github.com/dapugacheva>
B. Jupyter Lab and Software set up on GitHub:
1. Add the fill_color parameter to the r.choropleth function in the
ghsci.py (also consider adding fill and line opacity). @dapugacheva
<https://github.com/dapugacheva>
2. Add instructions on how to exit the software to the README file
after the description of the Compare function and before Citations:
*“Exit the web application (click the button in the top right-hand
corner) or type exit in the terminal window before closing the web app
browser window or go to File -> Shut Down in Jupyter Lab. Our website
provides detailed instructions on how to configure a new study region file
https://global-healthy-liveable-cities.github.io/software/#Details
<https://global-healthy-liveable-cities.github.io/software/#Details> and
what input data is required
https://global-healthy-liveable-cities.github.io/software/#Data.”
<https://global-healthy-liveable-cities.github.io/software/#Data.%E2%80%9D>*
@dapugacheva <https://github.com/dapugacheva>
3. Correct text errors in the Jupyter Notebook instructions: edit the
file path under the Sensitivity analysis description to
process/configuration/regions/example_ES_Las_Palmas_2023.yml
@dapugacheva <https://github.com/dapugacheva>
C. Instructions on the website
<https://global-healthy-liveable-cities.github.io/software/#Generate>:
1. Add a clearer and more separate paragraph in the "Software set up"
section about how to set up the software in different operation systems,
i.e., Windows/MacOS/Linux. @rychennn <https://github.com/rychennn>
2. Provide a checklist in the beginning on what to download before
starting the demo. @rychennn <https://github.com/rychennn>
3. Add the same instructions described above (4) to the website
<https://global-healthy-liveable-cities.github.io/software/#Compare>.
@dapugacheva <https://github.com/dapugacheva> @rychennn
<https://github.com/rychennn>
D. Docker Files @rychennn <https://github.com/rychennn> @dapugacheva
<https://github.com/dapugacheva>
1. Add the following code to the docker-build.sh file to fix the
ARM/AMD image error docker buildx build --push
--platform=linux/amd64,linux/arm64 -t
globalhealthyliveablecities/global-indicators .
- citations from
https://docs.docker.com/build/building/multi-platform/,
https://www.docker.com/blog/faster-multi-platform-builds-dockerfile-cross-compilation-guide/,
osmnx doker
<https://github.com/gboeing/osmnx/blob/main/environments/docker/docker-build.sh>
2. Disable the token for the docker to make sure that only one URL
pops up and works well.
3. Try to have two different commands to run the container in
different ways (web app and Jupyter lab)—rather than having the same
command to initiate the program and choose Web App/Jupyter Notebook with
another command.
—
Reply to this email directly, view it on GitHub
<https://github.com/global-healthy-liveable-cities/global-indicators/issues/375#issuecomment-1945120895>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/ADDCCMTT3X37PRNIX5M6A53YTVHMPAVCNFSM6AAAAABCQTGM7WVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSNBVGEZDAOBZGU>
.
You are receiving this because you were mentioned.Message ID:
<global-healthy-liveable-cities/global-indicators/issues/375/1945120895@
github.com>
|
Hi @dapugacheva and @rychennn, regarding,
I previously tried this and had some issues, presumably related to package compatability (as per e-mail I just sent); notes are here, in case you experience something similar: But, fingers crossed with updates to dependencies since then (about a year ago), perhaps things may just work now! |
…ghtweight alpine), environment.yml (to address dependabot alerts), and docker-build.bat to prepare multiplatform build; haven't fully tested, but so far at least the build looks successful on arm64, which is closer than we've gotten before (see #172 and #375); multiarch build sometimes still fails on a http error (docker suggests retrying as fix, and seems to work)
(apologies --- I was typing thinking I was on another window and accidentally modified the assignments, clearing all, then accidentally clicked on me Since I'm commenting (sorry for confusion there!) I've been looking into the Docker build since there were new dependabot alerts, and had a go with the arm64 architecture, possibly with some success. Just pushed the commit now (I was typing the commit message when I accidentally did the above when i flicked here to reference issue numbers). Anyway -- fingers crossed we are getting closer to arm64 support; thank you for raising this issue again. |
Jupyter Lab and Software set up on GitHub adjustments from issue #375
I am adding a common error encountered by some Windows users from the Mexico team when trying to launch Docker after installation. Solution:
This solution only works if you have admin access. Users may need IT support to solve the issue if the computer is not personal equipment. |
@eugenrb Did you reboot after installation? Depending on how you installed, the user may be auto added to the If that doesn't work, the solution may be simpler. From an admin-privileged command prompt run:
or
|
This happened to me on my UT laptop. Since I have admin credentials, I could fix it using the steps I shared. However, someone from the Mexico team could not resolve the issue because they used a university computer without admin credentials. In that case, per university policies, they could not change even with IT support. It may be worth adding a note that yo may need admin credentials to install docker. |
Yes indeed. Also, this looks well-documented in the Docker Desktop windows install instructions, so we should also be pointing users at those instructions if we're not currently. |
I run the software on a ThinkPad with Windows 10, with an AMD Ryzen 7 PRO 4750U with Radeon Graphics 1.70 GHz and 16 GB RAM. Web App
Instructions on the website:
|
Hi @jiyoon0120, thank you for having a look at the software. Can I just check, which version of the GHSCI software and Docker image are you running? Some of the aspects you've commented on sound like things we have changed, so before we look to plan what amendments might be made, I just want to check they haven't already been. We previously made changes to address how the URLs appear when launching the app, as seen in the current version of the software (4.6.0) --- although I accept its possible, things may appear differently on different user systems, its worth checking in case you might be using an earlier version before we have made some changes. For example, the instructions for accessing the GHSCI app are considerably simplified, as in below snippet: And reports are generated to a folder 'reports' already: I haven't been through all of your points yet sorry --- I'm working across multiple tasks --- but if you could just double check if you are using the current version of the software, and if not consider checking in case any of these aspects have already been addressed that would be really useful. Where issues remain, please feel welcome to contribute suggested modifications to code to address them. Pull requests are welcome! |
@carlhiggs I just downloaded the new version and ran it again. And yes, the second URL is gone now. What I meant 'Change the name of the folder to ‘reports’ was changing the word on the instruction website. Same with the 'View comparison', I suggested changing the word in the instruction to ‘VIEW COMPARISON’ and ‘EXPORT COMPARISON’ because I thought there was an icon 'View comparison'. For the popup indicator results, maybe we can add 'more information' that people can click on? Thanks! |
Thanks for picking up on these documentation aspects @jiyoon0120 --- Zara is currently updating our software instruction wiki and may be able to assist with some of these changes. @zarayousefi would you mind having a look at Jiyoon's suggestions for updates above and taking these into account when updating the Wiki? Thanks both! |
@carlhiggs @jiyoon0120 Do you mean to change "compare" to "VIEW COMPARISON" and "EXPORT COMPARISON"? I am not sure if I get the pop-up indicator result. Where is that exactly? Cheers, |
@zarayousefi The pop-up indicator result shows up when you click the region area figure on the map in the software. I think we can discuss more on this about how to revise the design to be more intuitive. Thanks, |
Hello all, I'm just making a note to clarify outstanding issues/suggestions to tackle Outstanding suggestions for GHSCI v4.6.0
and/or
and
and/or
|
Sounds good @jiyoon0120 , thanks for making the check boxes to keep us on track. If you're interested / it's helpful we could catch up sometime on teams/zoom and I could show you how I'd go about prototyping those changes (e.g. which file to edit, and how the nicegui framework that we are using works). You might be comfortable already with this kind of work, or interested in giving it a go, and if so you're most welcome to make some proposed edits and do a pull request. I'm in the UK for October so I think my 5pm will be your 9am. If you'd like to catch up some time later this week, we can if you'd like, to discuss how these changes could be made. Otherwise, I'll see what I can do; a few competing priorities this month (and always; I only work one day/week on this project, and after meetings not so much time left). But we'll get there eventually! |
Experience evaluation report of ghsci v4.4.10, main branch
The test was conducted on an Apple M2 Pro chip, 16GB RAM machine. Overall, The analysis worked as intended for the example city Las Palmas. Below are considerations regarding the user experience when running software in the Web App and Jupyter Lab.
Web App
Overall, the process went smoothly on the web app application for the example city. It took 20 minutes to run.
Key things to consider for improvements:
web_reports
toreports
(since the folder is called 'reports') in the website guidance in the Generate chapter.Jupyter Lab
GitHub is easy to follow for Jupyter Lab users. It is also more interactive and customizable (such as More advanced usage and mapping part). The process took about 15 minutes to run on the MacBook Pro Apple M2 Pro chip. ARM64 processor compatibility issue to resolve: The requested image's platform (linux/amd64) does not match the detected host platform (linux/arm64/v8) and no specific platform was requested 0.0s.
Key things to consider for improvements:
configure
output) and a map with pop-up window of indicators (analysis
output).color palette
parameter to ther.choropleth function
so users might adjust the color of the map.The report might be updated with new feedback as we continue to use the software.
The text was updated successfully, but these errors were encountered: