Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
marvinfriede committed Apr 25, 2024
1 parent c9a2880 commit 42a46fa
Show file tree
Hide file tree
Showing 3 changed files with 41 additions and 0 deletions.
17 changes: 17 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@
<a href="https://pypi.org/project/tad-dftd4/">
<img src="https://img.shields.io/pypi/v/tad-dftd4?color=orange" alt="PyPI"/>
</a>
<a href="https://anaconda.org/conda-forge/tad-dftd4">
<img src="https://img.shields.io/conda/vn/conda-forge/tad-dftd4.svg" alt="Conda Version"/>
</a>
<a href="http://www.apache.org/licenses/LICENSE-2.0">
<img src="https://img.shields.io/badge/License-Apache%202.0-orange.svg" alt="Apache-2.0"/>
</a>
Expand All @@ -28,6 +31,12 @@
<a href="https://github.com/dftd4/tad-dftd4/actions/workflows/ubuntu.yaml">
<img src="https://github.com/dftd4/tad-dftd4/actions/workflows/ubuntu.yaml/badge.svg" alt="Test Status Ubuntu"/>
</a>
<a href="https://github.com/dftd4/tad-dftd4/actions/workflows/macos.yaml">
<img src="https://github.com/dftd4/tad-dftd4/actions/workflows/macos.yaml/badge.svg" alt="Test Status macOS"/>
</a>
<a href="https://github.com/dftd4/tad-dftd4/actions/workflows/windows.yaml">
<img src="https://github.com/dftd4/tad-dftd4/actions/workflows/windows.yaml/badge.svg" alt="Test Status Windows"/>
</a>
<a href="https://github.com/dftd4/tad-dftd4/actions/workflows/release.yaml">
<img src="https://github.com/dftd4/tad-dftd4/actions/workflows/release.yaml/badge.svg" alt="Build Status"/>
</a>
Expand Down Expand Up @@ -69,6 +78,14 @@ For alternative implementations, also check out:
pip install tad-dftd4
```

### conda

_tad-dftd4_ is also available from `conda`.

```sh
conda install tad-dftd4
```

### From source

This project is hosted on GitHub at [dftd4/tad-dftd4](https://github.com/dftd4/tad-dftd4).
Expand Down
8 changes: 8 additions & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ Torch autodiff for DFT-D4
:target: https://github.com/dftd4/tad-dftd4/actions/workflows/ubuntu.yaml
:alt: Test Status Ubuntu

.. image:: https://github.com/dftd4/tad-dftd4/actions/workflows/macos.yaml/badge.svg
:target: https://github.com/dftd4/tad-dftd4/actions/workflows/macos.yaml
:alt: Test Status macOS

.. image:: https://github.com/dftd4/tad-dftd4/actions/workflows/windows.yaml/badge.svg
:target: https://github.com/dftd4/tad-dftd4/actions/workflows/windows.yaml
:alt: Test Status Windows

.. image:: https://readthedocs.org/projects/tad-dftd4/badge/?version=latest
:target: https://tad-dftd4.readthedocs.io
:alt: Documentation Status
Expand Down
16 changes: 16 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,28 @@ Installation
pip
~~~

.. image:: https://img.shields.io/pypi/v/tad-dftd4
:target: https://pypi.org/project/tad-dftd4/
:alt: PyPI

*tad-dftd4* can easily be installed with ``pip``.

.. code::
pip install tad-dftd4
conda
~~~~~

.. image:: https://img.shields.io/conda/vn/conda-forge/tad-dftd4.svg
:target: https://anaconda.org/conda-forge/tad-dftd4
:alt: Conda Version

*tad-dftd4* is also available from ``conda``.

.. code::
conda install tad-dftd4
From source
~~~~~~~~~~~
Expand Down

0 comments on commit 42a46fa

Please sign in to comment.