Skip to content

Commit

Permalink
updated landing page and Getting Started
Browse files Browse the repository at this point in the history
  • Loading branch information
orionarcher committed Aug 19, 2021
1 parent aea1433 commit b9db52d
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
11 changes: 10 additions & 1 deletion docs/getting_started.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,13 @@
Getting Started
===============

This page details how to get started with SolvationAnalysis.
Solvation analysis makes it easy to rapidly analyze coordination, species-species pairing,
and speciation. While solvation analysis is designed with molecular (and especially ionic)
systems in mind, it's methods should be extensible to any system where a solute is
dissolved in solvents.

Get started with solvation_analysis by working through the basics_tutorial.ipynb
Jupyter notebook which can be found in the tutorials section of the
`GitHub <https://github.com/MDAnalysis/solvation-analysis>`_. The tutorial
introduces the basic functionality and usage of the solvation_analysis package.

10 changes: 10 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,16 @@
Welcome to SolvationAnalysis's documentation!
=========================================================

Solvation analysis implements a `robust, cohesive, and fast set of methods
<https://summerofcode.withgoogle.com/projects/#6227159028334592>`_ for
analyzing the solvation structure of a liquid. It seamlessly integrates with
`MDAnalysis <https://www.mdanalysis.org/>`_, making use of the core AtomGroup
and Universe data structures to parse solvation information. If you are interested
in understanding the solvation structure of a liquid, this package is for you!

To get started, check out the Getting Started section of the documentation.


.. toctree::
:maxdepth: 2
:caption: Contents:
Expand Down

0 comments on commit b9db52d

Please sign in to comment.