diff --git a/README.md b/README.md index 2451aa4..8005fa7 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,7 @@ +
quansino
:game_die:Modular Stochastic Simulations for Atomistic Modelling
@@ -11,7 +15,7 @@ [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit) -`quansino` is a modern simulation framework designed for both material science and molecular systems based on the Atomic Simulation Environment (ASE). It combines the reliability of established Monte Carlo and general sampling methods with an intuitive, and flexible Python interface. +`quansino` is a modern simulation framework based on the Atomic Simulation Environment (ASE) designed for both material science and molecular systems. It combines the reliability of established Monte Carlo and general sampling methods with an intuitive, and flexible Python interface. ## Key Features :slot_machine: diff --git a/docs/images/ammonia.png b/docs/images/ammonia.png new file mode 100644 index 0000000..eb43153 Binary files /dev/null and b/docs/images/ammonia.png differ diff --git a/docs/images/quansino_logo.png b/docs/images/quansino_logo.png new file mode 100644 index 0000000..98c1918 Binary files /dev/null and b/docs/images/quansino_logo.png differ diff --git a/docs/images/water.png b/docs/images/water.png new file mode 100644 index 0000000..9569fe8 Binary files /dev/null and b/docs/images/water.png differ diff --git a/docs/index.md b/docs/index.md index 817916f..f0809de 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,7 @@ # Home -The `quansino` code aim to provide a simple-to-use platform for quickly creating customized Monte Carlo simulations. The code is based on [`ase`](https://wiki.fysik.dtu.dk/ase/) and aim to be modular and flexible. +The `quansino` code aims to provide a simple-to-use platform for quickly creating customized Monte Carlo simulations. The code is based on the [Atomic Simulation Environment (ASE)](https://wiki.fysik.dtu.dk/ase/) and aim to be modular and flexible. + +*** + +![Quansino Logo](images/quansino_logo.png) diff --git a/docs/installation/install.md b/docs/installation/install.md index 1bd644e..6cef157 100644 --- a/docs/installation/install.md +++ b/docs/installation/install.md @@ -3,5 +3,3 @@ The `quansino` package is not yet available on PyPI, but can be installed from t ```bash pip install git+https://github.com/Atomic-Samplers/quansino.git ``` - -Current dependencies include `numpy` and `ase`. diff --git a/mkdocs.yml b/mkdocs.yml index 461be61..7cb5323 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -9,7 +9,7 @@ nav: - Documentation: - documentation/overview.md - documentation/examples.md - - Code Documentation: reference/ # keep me! + - Code Documentation: reference/ - About: - about/changelog.md - about/conduct.md @@ -19,6 +19,7 @@ repo_url: https://github.com/Atomic-Samplers/quansino/ edit_uri: blob/main/docs/ theme: + favicon: images/water.png features: - content.action.edit - content.code.copy @@ -36,6 +37,11 @@ theme: - search.share - header.autohide - toc.follow + extra_css: + - stylesheets/extra.css + extra_javascript: + - javascripts/extra.js + logo: images/ammonia.png name: material palette: - media: "(prefers-color-scheme: light)"