Skip to content

Commit d07bcbc

Browse files
committed
added a whatis Scatterkit section to the README
1 parent 27c2b02 commit d07bcbc

1 file changed

Lines changed: 19 additions & 1 deletion

File tree

README.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,25 @@ Scatterkit
55

66
.. inclusion-readme-intro-start
77
8-
Scatterkit does SAXS analysis of molecular dynamics simulations.
8+
**Scatterkit** is an object-oriented python toolkit for analysing scattering of
9+
fluids from molecular simulations. Combined with MDAnalysis_,
10+
Scatterkit can be used to extract X-ray scattering data from trajectory files,
11+
including LAMMPS, GROMACS, CHARMM or NAMD data. Scatterkit is open source and is
12+
released under the GNU general public license v3.0.
13+
14+
Scatterkit is a tool for beginners of molecular simulations with no prior Python experience.
15+
For these users Scatterkit provides a descriptive command line interface. Also experienced
16+
users can use the Python API for their day to day analysis.
17+
18+
Scatterkit is maintained by the MAICoS developer team.
19+
Keep up to date with Scatterkit news by following us on Twitter_. If you find an issue, you
20+
can report it on GitHub_. You can also join the developer team on Discord_ to discuss
21+
possible improvements and usages of Scatterkit.
22+
23+
.. _`MDAnalysis`: https://www.mdanalysis.org
24+
.. _`Twitter`: https://twitter.com/maicos_analysis
25+
.. _`GitHub`: https://github.com/maicos-devel/scatterkit
26+
.. _`Discord`: https://discord.gg/mnrEQWVAed
927

1028
.. inclusion-readme-intro-end
1129

0 commit comments

Comments
 (0)