Skip to content

Commit

Permalink
DOC: update support & contribute section, bump ver to 3.1.1
Browse files Browse the repository at this point in the history
  • Loading branch information
the-hampel committed Sep 12, 2022
1 parent fd41678 commit 62fb3e3
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 15 deletions.
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ endif()

# ############
# Define Project
project(solid_dmft VERSION 3.1.0 LANGUAGES C CXX)
project(solid_dmft VERSION 3.1.1 LANGUAGES C CXX)
get_directory_property(IS_SUBPROJECT PARENT_DIRECTORY)

# ############
Expand Down
11 changes: 6 additions & 5 deletions doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,12 @@ solid_dmft

This program allows to perform DFT+DMFT ''one-shot'' and charge self-consistent
(CSC) calculations from h5 archives or VASP/Quantum Espresso input files for
multiband systems using the TRIQS software library, and the DFT code interface
`TRIQS/DFTTools <https://triqs.github.io/dft_tools>`_. Works with triqs >3.x.x.
solid_dmft takes advantage of various impurity solvers available in triqs: cthyb,
HubbardI, ForkTPS, ctint, and ctseg. Postprocessing scripts are available to
perform analytic continuation and calculate spectral functions.
multiband systems using the `TRIQS software library <https://triqs.github.io>`_, and the DFT code interface
`TRIQS/DFTTools <https://triqs.github.io/dft_tools>`_. Works with triqs >3.x.x.
solid_dmft takes advantage of various
`impurity solvers available <https://triqs.github.io/triqs/latest/applications.html#impurity-solvers>`_
in triqs: cthyb, HubbardI, ForkTPS, ctint, and ctseg. Postprocessing scripts are available to
perform analytic continuation and calculate spectral functions.

For installation use the same branch / tag as your triqs installation. More
information under :ref:`installation`.
Expand Down
32 changes: 23 additions & 9 deletions doc/issues.rst
Original file line number Diff line number Diff line change
@@ -1,19 +1,33 @@
.. _issues:

*****************
How to contribute
*****************
********************
Support & contribute
********************

Seeking help
============

Improving solid_dmft
====================
If you have any questions please ask them on the solid_dmft github discussion page:
`<https://github.com/flatironinstitute/solid_dmft/discussions>`_. However, note
that solid_dmft is targeted at experienced users of DMFT, and we can only provide
technial support for the code itself not for theory questions about the utilized methods.

Also make sure to ask only questions relevant for solid_dmft. For questions
regarding other parts of TRIQS use the discussions page of the respective TRIQS
application.

solid_dmft is targeted at experienced users of DMFT. If you have suggestions or
questions, please use github discussion
`<https://github.com/flatironinstitute/solid_dmft/discussions>`_.
Take also a look at the :ref:`tutorials` section of the documentation for examples, and
the official `TRIQS tutorial page <https://github.com/TRIQS/tutorials>`_ for even more
tutorials.

We encourage pull requests with new features or helpful postprocessing scripts.

Improving solid_dmft
====================

Please post suggestions for new features on the `github discussion page
<https://github.com/flatironinstitute/solid_dmft/discussions>`_ or create
directly a pull request with new features or helpful postprocessing scripts
via github.

Reporting issues
================
Expand Down

0 comments on commit 62fb3e3

Please sign in to comment.