Skip to content

Commit

Permalink
add docs
Browse files Browse the repository at this point in the history
  • Loading branch information
maxscheurer committed Jan 12, 2022
1 parent f07b131 commit b712033
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/calculations.rst
Expand Up @@ -324,6 +324,10 @@ obtained using the function ``adcc.get_n_threads()``.
Plotting spectra
----------------

.. note::
For plotting spectra, `Matplotlib <https://matplotlib.org>`_
needs to be installed. See :ref:`optional-dependencies` for details.

Having computed a set of ADC excited states as discussed in the
previous sections, these can be visualised
in a simulated absorption spectrum
Expand Down
17 changes: 17 additions & 0 deletions docs/installation.rst
Expand Up @@ -18,6 +18,9 @@ Please get in touch
by `opening an issue <https://github.com/adc-connect/adcc/issues>`_
if you cannot get adcc to work.

Some specialty features of adcc require extra dependencies (Pandas and
Matplotlib), see :ref:`optional-dependencies` for details.

Installing adcc
---------------

Expand Down Expand Up @@ -154,6 +157,20 @@ the :ref:`devnotes` will provide
you with some useful pointers to get started.


.. _optional-dependencies:

Optional dependencies for analysis features
-------------------------------------------

Special functionality, i.e., plotting spectra (:func:`adcc.ExcitedStates.plot_spectrum`)
relies on Matplotlib, which is not installed by default along with adcc due to
its heavy dependencies. Similarly, export of excited states data to `pandas.DataFrame`
requires Pandas (:func:`adcc.ExcitedStates.to_dataframe`). If you want to include these
dependencies directly while installing adcc, you can run ``pip install adcc[analysis]''.
Manual installation via ``pip install matplotlib'' or ``conda install matplotlib''
is of course also possible. Note that all other core features of adcc still work without
these packages installed.
.. _troubleshooting:
Expand Down

0 comments on commit b712033

Please sign in to comment.