Merge pull request #161 from TRI-AMDD/TRI-37216-tutorial-add-new-link…

…-to-phrase-boundary-values

updated site to reflect requested changes

ui/src/pages/FAQ/FAQ.tsx

@@ -6,6 +6,7 @@ import { FAQ_ITEMS, URL_FAQ_STRING_MATCH } from './faq-util/faq-text';
 import ExpandMoreIcon from '@mui/icons-material/ExpandMore';
 import ExpandLessIcon from '@mui/icons-material/ExpandLess';
 import { useLocation } from 'react-router-dom';
+import IDESAllElements from '@/Assets/Images/IDES_all_elements.pdf';
 
 export function FAQ() {
     const [expanded, setExpanded] = useState<string[]>([]);
@@ -107,6 +108,31 @@ export function FAQ() {
                                 </Accordion>
                             );
                         })}
+                        <Accordion
+                            expanded={expanded.includes(`panel${FAQ_ITEMS.length}`)}
+                            onChange={handleAccordianChange(`panel${FAQ_ITEMS.length}`)}
+                            id={`faq-${FAQ_ITEMS.length}`}
+                            key={`faq-${FAQ_ITEMS.length}`}
+                        >
+                            <AccordionSummary
+                                expandIcon={<ExpandMoreIcon />}
+                                aria-controls={`panel${FAQ_ITEMS.length}-content`}
+                                id={`panel${FAQ_ITEMS.length}-header`}
+                            >
+                                <Typography component={'div'} variant="body1">
+                                    Do you have a printable figure of the electrochemical series including all elements?
+                                </Typography>
+                            </AccordionSummary>
+                            <AccordionDetails>
+                                <Typography component={'div'} variant="body1">
+                                    Yes, you may download this{' '}
+                                    <a href={IDESAllElements} download={`IDES_All_Elements.pdf`}>
+                                        figure
+                                    </a>
+                                    .
+                                </Typography>
+                            </AccordionDetails>
+                        </Accordion>
                     </div>
                 </div>
             </div>

ui/src/pages/FAQ/faq-util/faq-text.tsx

@@ -76,9 +76,6 @@ export const FAQ_ITEMS: FAQText[] = [
         question: 'Can I download all of the oxidation state ranges?',
         answer: `
         The oxidation state ranges for all available species can be downloaded in JSON format <a rel='noopener noreferrer' target='_blank' href='https://www.oxi.matr.io/oxidation_boundaries.json'>here</a>. The units are the same as those used on this web site.
-        <br /> You can also download a high-resolution 
-        <a rel='noopener noreferrer' target='_blank' href='https://www.oxi.matr.io/IDES_all_elements.pdf'>graphical representation</a> 
-        of the oxidation state ranges for all 84 elements included in our model.
         `
     }
 ];

ui/src/pages/Tutorial/constants.ts

@@ -64,7 +64,7 @@ export const text15 = `We can generalize the above analysis to determine the mos
 
 export const text16 = `To apply this approach, it is necessary to have good estimates for the width of the logistic function (i.e. the amount of uncertainty) for each boundary between oxidation states and for the locations of the boundaries. Here we have used the approximation that the logistic functions all have the same width and determined the boundary locations through machine learning.  Specifically, we collected a set of over 50,000 materials with labeled oxidation states from the <a rel='noopener noreferrer' target='_blank' href='https://icsd.products.fiz-karlsruhe.de/'>Inorganic Crystal Structure Database</a> (ICSD), and then we found the boundary values that maximized the geometric mean likelihood score of the labeled oxidation states.  To prevent the minimum and maximum boundary values from diverging to positive or negative infinity, we regularized the fit by applying a slight penalty proportional to the difference between the maximum and minimum boundary values for each oxidation state.`;
 
-export const text17 = `The boundary values discovered by our machine learning algorithm do not have any physical units; we only know that they should change monotonically with the electronic chemical potential.  Although this relationship does not necessarily have to be linear, a comparison between the boundary values we calculate and the standard reduction potentials for ions in solution reveals a roughly linear relationship. To facilitate the interpretation of the oxidation state range data, we have used this relationship to linearly scale the boundary values so that they are expressed in units roughly corresponding to volts. We call the resulting scale for these values the "ICSD-derived reduction potential" (IRP), and represent it with the symbol "E". Accordingly, on the web site we use E and E<sub>opt</sub>, in place of μ<sub>e</sub> and μ<sub>opt</sub> respectively.
+export const text17 = `The <a rel='noopener noreferrer' target='_blank' href='/faq/#faq-14'>boundary values</a> discovered by our machine learning algorithm do not have any physical units; we only know that they should change monotonically with the electronic chemical potential.  Although this relationship does not necessarily have to be linear, a comparison between the boundary values we calculate and the standard reduction potentials for ions in solution reveals a roughly linear relationship. To facilitate the interpretation of the oxidation state range data, we have used this relationship to linearly scale the boundary values so that they are expressed in units roughly corresponding to volts. We call the resulting scale for these values the "ICSD-derived reduction potential" (IRP), and represent it with the symbol "E". Accordingly, on the web site we use E and E<sub>opt</sub>, in place of μ<sub>e</sub> and μ<sub>opt</sub> respectively.
 `;
 
 export const text18 = `Polyatomic ions are ions that contain more than one atom. Such ions can have their own oxidation state ranges that are significantly different from the ranges of the individual atoms.  For example, we find that S<sup>6+</sup> is stable in much more reducing conditions when in a (SO<sub>4</sub>)<sup>2-</sup> ion than when in a single sulfur ion.  We have calculated oxidation state ranges for 23 of the most common polyatomic ions:  AsO<sub>4</sub>, BO<sub>3</sub>, C<sub>2</sub>O<sub>4</sub>, CIO<sub>4</sub>, CN, CO, CrO<sub>4</sub>, GeO<sub>4</sub>, MoO<sub>4</sub>, NO<sub>2</sub>, NO<sub>3</sub>, P<sub>2</sub>O<sub>7</sub>, PO<sub>3</sub>, PO<sub>4</sub>, PS<sub>4</sub>, SeO<sub>3</sub>, SeO<sub>4</sub>, SiO<sub>4</sub>, SO<sub>2</sub>, SO<sub>3</sub>, SO<sub>4</sub>, and WO<sub>4</sub>. Represenative structures of these polyatomic ions in xyz format can be downloaded <a rel='noopener noreferrer' target='_blank' href='https://www.oxi.matr.io/polyatomic_ion_xyz_files.tar.gz'>here</a>. These will be auto-detected if contained in an uploaded structure. If you want to specify a polyatomic ion in a composition, surround the ion type from the above list with parenthesis.  E.g. (SO<sub>4</sub>) would represent a sulfate ion.`;