Skip to content

Commit

Permalink
Add logos to README and docs (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomdemeyere authored Jan 6, 2025
1 parent 81276e1 commit 4c77159
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 5 deletions.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<div align="center">
<img src=docs/images/quansino_logo.png width="400"><br>
</div>

<div align="center">
<h1><code>quansino</code> :game_die:</h1>
<p><i>Modular Stochastic Simulations for Atomistic Modelling</i></p>
Expand All @@ -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:

Expand Down
Binary file added docs/images/ammonia.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/quansino_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/water.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 5 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -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)
2 changes: 0 additions & 2 deletions docs/installation/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
8 changes: 7 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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)"
Expand Down

0 comments on commit 4c77159

Please sign in to comment.