Text review and update #281

unkcpz · 2022-09-19T11:27:03Z

fixes #277

Update text on feedback from Nicola.

for more information, see https://pre-commit.ci

mbercx

Thanks @unkcpz! I've left a few comments.

mbercx · 2022-09-20T09:32:37Z

aiidalab_qe/process.py

@@ -28,7 +28,9 @@ class WorkChainSelector(ipw.HBox):
    FMT_WORKCHAIN = "{wc.pk:6}{wc.ctime:>10}\t{wc.state:<16}\t{wc.formula} \t {wc.relax_info} \t {wc.properties_info}"

    def __init__(self, **kwargs):
-        self.work_chains_prompt = ipw.HTML("<b>Select workflow or start new:</b>&nbsp;")
+        self.work_chains_prompt = ipw.HTML(
+            "<b>Select computed workflow or start a new:</b>&nbsp;"


I'd still add "one" here at the end ("start a new one"). But the sentence is already taking up quite a bit of space as it is 😅

There is a lot of space for this line, but I still prefer without 'one' which is more straightforward.

But this is grammatically incorrect?

mbercx · 2022-09-20T09:34:34Z

aiidalab_qe/static/welcome.jinja

-  The <a href="https://www.quantum-espresso.org/" target="_blank">Quantum ESPRESSO</a> app (or QE app for short) is a graphical interface for calculating material properties based on density-functional theory (DFT).
-  Each of the properties is calculated by workflows powered by the <a href="https://www.aiida.net/" target="_bland"> AiiDA engine</a>, and maintained in the <a href="https://aiida-quantumespresso.readthedocs.io/en/latest/" target="_blank"> Quantum ESPRESSO plugin</a> for AiiDA.
+  The <a href="https://www.quantum-espresso.org/" target="_blank">Quantum ESPRESSO</a> app (or QE app for short) is a graphical front end for calculating materials properties using Quantum ESPRESSO (QE).
+  Each of the property is calculated by workflows powered by the <a href="https://www.aiida.net/" target="_bland"> AiiDA engine</a>, and maintained in the <a href="https://aiida-quantumespresso.readthedocs.io/en/latest/" target="_blank"> Quantum ESPRESSO plugin</a> for AiiDA.


This change seems incorrect? Maybe "Each property"?

aiidalab_qe/steps.py

unkcpz

@mbercx thanks! I am for sure not able to judge which phrase is better because of my poor ENG writing 😆 But I think we can loose a bit, I accept some requests and it is good to go I guess.

unkcpz · 2022-09-20T10:05:25Z

aiidalab_qe/process.py

@@ -28,7 +28,9 @@ class WorkChainSelector(ipw.HBox):
    FMT_WORKCHAIN = "{wc.pk:6}{wc.ctime:>10}\t{wc.state:<16}\t{wc.formula} \t {wc.relax_info} \t {wc.properties_info}"

    def __init__(self, **kwargs):
-        self.work_chains_prompt = ipw.HTML("<b>Select workflow or start new:</b>&nbsp;")
+        self.work_chains_prompt = ipw.HTML(
+            "<b>Select computed workflow or start a new:</b>&nbsp;"


There is a lot of space for this line, but I still prefer without 'one' which is more straightforward.

aiidalab_qe/steps.py

Co-authored-by: Marnik Bercx <mbercx@gmail.com>

mbercx

All good! 🚀

csadorf

I've found a few issues, maybe we can fix them in a separate PR.

csadorf · 2022-09-20T10:40:15Z

aiidalab_qe/process.py

@@ -28,7 +28,9 @@ class WorkChainSelector(ipw.HBox):
    FMT_WORKCHAIN = "{wc.pk:6}{wc.ctime:>10}\t{wc.state:<16}\t{wc.formula} \t {wc.relax_info} \t {wc.properties_info}"

    def __init__(self, **kwargs):
-        self.work_chains_prompt = ipw.HTML("<b>Select workflow or start new:</b>&nbsp;")
+        self.work_chains_prompt = ipw.HTML(
+            "<b>Select computed workflow or start a new:</b>&nbsp;"


But this is grammatically incorrect?

csadorf · 2022-09-20T10:43:54Z

aiidalab_qe/pseudos.py

@@ -43,8 +43,7 @@ class PseudoFamilySelector(ipw.VBox):
    )
    dft_functional_help = ipw.HTML(
        """<div style="line-height: 140%; padding-top: 10px; padding-bottom: 10px; opacity:0.5;">
-        The exchange-correlation energy is calculated based on the charge
-        density using this functional. We currently provide support for two
+        The exchange-correlation energy is calculated functional. We currently provide support for two


The exchange-correlation energy is calculated functional.

That sounds weird to me. Should it say "is calculated via a functional" ?

csadorf · 2022-09-20T10:44:41Z

aiidalab_qe/steps.py

        accuracy and speed. Choose the "fast" protocol for a faster calculation
-        with less precision and the "precise" protocol that provides more
-        accuracy but will take longer.</div>"""
+        with less precision and the "precise" protocol to aim at best accuracy (at the prece of longer/costlier calculations).</div>"""


typo: "prece"

csadorf · 2022-09-20T10:45:04Z

aiidalab_qe/steps.py

@@ -165,7 +168,8 @@ class SmearingSettings(ipw.VBox):
    smearing_description = ipw.HTML(
        """<p>
        The smearing type and width is set by the chosen <b>protocol</b>.
-        Tick the box to override the default.
+        Tick the box to override the default, not advised unless you've mastered <b>smearing effects</b> (click <a href="http://theossrv1.epfl.ch/Main/ElectronicTemperature"


Why is "HERE" block-capitalized?

unkcpz · 2022-09-20T11:00:15Z

Thanks @csadorf, they are addressed by #296

Supplementary and fixes for #281

unkcpz added 6 commits September 19, 2022 09:34

update welcome page

3130d1c

workflow selector

c9a601b

Step 2 update

46c7cf0

step 2 adv updated

65b4959

Step 4 update

8afbd0f

r

91d71cc

unkcpz requested review from csadorf and mbercx September 19, 2022 11:27

[pre-commit.ci] auto fixes from pre-commit.com hooks

14852ab

for more information, see https://pre-commit.ci

unkcpz added this to the 2nd Live testing with Nicola milestone Sep 20, 2022

mbercx requested changes Sep 20, 2022

View reviewed changes

r1

6b79495

unkcpz commented Sep 20, 2022

View reviewed changes

Update aiidalab_qe/steps.py

114fd98

Co-authored-by: Marnik Bercx <mbercx@gmail.com>

unkcpz requested a review from mbercx September 20, 2022 10:10

Apply suggestions from code review

1bd1514

Co-authored-by: Marnik Bercx <mbercx@gmail.com>

mbercx approved these changes Sep 20, 2022

View reviewed changes

unkcpz merged commit 9d927a7 into master Sep 20, 2022

unkcpz deleted the fix/277/nicola-text-feedback branch September 20, 2022 10:28

csadorf reviewed Sep 20, 2022

View reviewed changes

unkcpz added a commit that referenced this pull request Sep 20, 2022

More text and typo fixes (#296)

d95ea88

Supplementary and fixes for #281

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Text review and update #281

Text review and update #281

unkcpz commented Sep 19, 2022 •

edited

Loading

mbercx left a comment

mbercx Sep 20, 2022

unkcpz Sep 20, 2022

csadorf Sep 20, 2022

mbercx Sep 20, 2022

unkcpz Sep 20, 2022

unkcpz left a comment •

edited

Loading

unkcpz Sep 20, 2022

mbercx left a comment

csadorf left a comment

csadorf Sep 20, 2022

csadorf Sep 20, 2022

csadorf Sep 20, 2022

csadorf Sep 20, 2022

unkcpz commented Sep 20, 2022

Text review and update #281

Text review and update #281

Conversation

unkcpz commented Sep 19, 2022 • edited Loading

mbercx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unkcpz left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mbercx left a comment

Choose a reason for hiding this comment

csadorf left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

unkcpz commented Sep 20, 2022

unkcpz commented Sep 19, 2022 •

edited

Loading

unkcpz left a comment •

edited

Loading