Skip to content

Commit c7e965b

Browse files
authored
(docs) minor polishing of the documentation page
1 parent 7293408 commit c7e965b

File tree

1 file changed

+5
-11
lines changed

1 file changed

+5
-11
lines changed

docs/index.rst

Lines changed: 5 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -91,9 +91,7 @@ pySIPFENN
9191
:target: https://doi.org/10.48550/arXiv.2404.02849
9292
:alt: 2024 Paper DOI
9393

94-
This repository contains
95-
**py** thon toolset for **S** tructure- **I** nformed **P** roperty and **F** eature **E** ngineering with **N** eural **N** etworks
96-
which implements a numer of user-friendly tools for:
94+
``pySIPFENN`` or **py** thon toolset for **S** tructure- **I** nformed **P** roperty and **F** eature **E** ngineering with **N** eural **N** etworks implements a numer of researcher-friendly tools for:
9795

9896
- **Calculating different vector representations of atomic structures** for a number of applications including supervised (e.g., predictive machine learning models) and unsupervised learning (e.g., clustering of atomic structures based on similarity or performing anomaly detection). Notably, utilize crystallographic information and some other techniques to make this process very efficient for the vast majority of use cases (see `arXiv:2404.02849 <https://arxiv.org/abs/2404.02849>`_).
9997

@@ -103,13 +101,12 @@ which implements a numer of user-friendly tools for:
103101

104102
The underlying methodology, efficiency optimizations, design choices, and implementation specifics are given in the following publications:
105103

106-
- Adam M. Krajewski, Jonathan W. Siegel, Zi-Kui Liu, _Efficient Structure-Informed Featurization and Property Prediction of Ordered, Dilute, and Random Atomic Structures_, April 2024, `arXiv:2404.02849 <https://arxiv.org/abs/2404.02849>`_
104+
- Adam M. Krajewski, Jonathan W. Siegel, Zi-Kui Liu, `Efficient Structure-Informed Featurization and Property Prediction of Ordered, Dilute, and Random Atomic Structures`, April 2024, `arXiv:2404.02849 <https://arxiv.org/abs/2404.02849>`_
107105

108-
- Adam M. Krajewski, Jonathan W. Siegel, Jinchao Xu, Zi-Kui Liu, _Extensible Structure-Informed Prediction of Formation Energy with improved accuracy and usability employing neural networks_, Computational Materials Science, Volume 208, 2022, 111254, DOI: `10.1016/j.commatsci.2022.111254 <https://doi.org/10.1016/j.commatsci.2022.111254>`_
106+
- Adam M. Krajewski, Jonathan W. Siegel, Jinchao Xu, Zi-Kui Liu, `Extensible Structure-Informed Prediction of Formation Energy with improved accuracy and usability employing neural networks`, Computational Materials Science, Volume 208, 2022, 111254, DOI: `10.1016/j.commatsci.2022.111254 <https://doi.org/10.1016/j.commatsci.2022.111254>`_
109107

110-
A more complete (and verbose) description of capabilities is
111-
given in documentation at `(pysipfenn.org) <https://pysipfenn.org>`_. You may also consider visiting our
112-
Phases Research Lab website at `(phaseslab.org) <https://phaseslab.org>`_.
108+
The source code and developement discussions are available in the GitHub repository at `(git.pysipfenn.org) <https://git.pysipfenn.org>`_.
109+
You may also consider visiting our Phases Research Lab website at `(phaseslab.org) <https://phaseslab.org>`_.
113110

114111
News
115112
----
@@ -143,9 +140,6 @@ News
143140
`Materials Genome Foundation <https://materialsgenomefoundation.org>`__, such a success! Over 100 of you simultaneously followed
144141
all exercises and, at the peak, we loaded over 1,200GB of models into the HPC's RAM.
145142

146-
.. note::
147-
This project is under active development. We recommend using released (stable) versions.
148-
149143

150144
Main Schematic
151145
--------------

0 commit comments

Comments
 (0)