-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* start the documentation * add readthedocs yaml
- Loading branch information
1 parent
1187532
commit 78892c2
Showing
9 changed files
with
255 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# .readthedocs.yaml | ||
# Read the Docs configuration file | ||
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details | ||
|
||
# Required | ||
version: 2 | ||
|
||
# Set the version of Python and other tools you might need | ||
build: | ||
os: ubuntu-22.04 | ||
tools: | ||
python: "3.12" | ||
|
||
mkdocs: | ||
configuration: mkdocs.yml | ||
|
||
# install package via pip | ||
python: | ||
install: | ||
- requirements: requirements.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# API Documentation |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
# Graphical user interface |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# RIMSSchemeDrawer Documentation | ||
|
||
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) | ||
[![Rye](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/mitsuhiko/rye/main/artwork/badge.json)](https://rye-up.com) | ||
[![PyPI](https://img.shields.io/pypi/v/rimsschemedrawer)](https://pypi.org/project/rimsschemedrawer/) | ||
[![Documentation Status](https://readthedocs.org/projects/rimsschemedrawer/badge/?version=latest)](https://rimsschemedrawer.readthedocs.io/en/latest/?badge=latest) | ||
[![codecov](https://codecov.io/gh/RIMS-Code/RIMSSchemeDrawer/graph/badge.svg?token=TUUIKGLGGD)](https://codecov.io/gh/RIMS-Code/RIMSSchemeDrawer) | ||
[![tests](https://github.com/RIMS-Code/RIMSSchemeDrawer/actions/workflows/package_testing.yml/badge.svg)](https://github.com/RIMS-Code/RIMSSchemeDrawer/actions/workflows/package_testing.yml) | ||
|
||
## Welcome! | ||
|
||
As the name implies, | ||
the `RIMSSchemeDrawer` is a tool to draw resonance ionization schemes. | ||
The goal of this package is to create a publication-ready figure. | ||
|
||
The easiest way to use the software is via a graphical user interface (GUI). | ||
However, the software can also be used as a library. | ||
Please see the [API documentation](api/index.md) for more information. | ||
|
||
## Next steps | ||
|
||
Please check out the [installation guide](install.md) to get started. | ||
While the GUI is fairly self-explanatory | ||
and includes many tool-tips to help you navigate, | ||
you might also want to check out the [how-to guide](gui.md). | ||
|
||
## Issues/Enhancements | ||
|
||
If you run into any problems with the software | ||
or have ideas for enhancements, | ||
please raise an issue [here on GitHub](https://github.com/RIMS-Code/RIMSSchemeDrawer/issues). | ||
|
||
## License | ||
|
||
This software is licensed under the [MIT license](https://github.com/RIMS-Code/RIMSSchemeDrawer/blob/main/LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,37 @@ | ||
# Installation | ||
|
||
We provide two main ways of installation, | ||
either directly via `pip` or using the fully packaged installer | ||
that can be found in our [releases](https://github.com/RIMS-Code/RIMSSchemeDrawer/releases). | ||
|
||
!!! note "Fully packaged installer" | ||
As of version `v3`, the fully packaged release is created with | ||
[`PyApp`](https://ofek.dev/pyapp/latest/). | ||
This has various advantages for our own workflow, | ||
however, requires that you have an internet connection when first starting the software. | ||
`PyApp` will create a virtual environment for you and install the software there, | ||
however, will need to download all dependencies in the process. | ||
|
||
## Installation via `pip` | ||
|
||
We highly recommend using [`pipx`](https://pipxproject.github.io/pipx/) | ||
to install the software. | ||
To do so, | ||
simply run the following command in your terminal: | ||
|
||
```bash | ||
pipx install rimsschemedrawer[gui] | ||
``` | ||
|
||
This will install the software and all its dependencies in an isolated environment. | ||
You can then run the software by simply typing `rimsschemedrawer` in your terminal. | ||
|
||
## Installation via the fully packaged installer | ||
|
||
Download the latest release from [here](https://github.com/RIMS-Code/RIMSSchemeDrawer/releases) | ||
by choosing the appropriate file for your operating system. | ||
After downloading, | ||
simply run the file. | ||
|
||
!!! note | ||
The files are not signed and you might get a warning from your operating system. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,48 @@ | ||
site_name: RIMSSchemeDrawer | ||
|
||
theme: | ||
name: material | ||
features: | ||
- content.code.copy | ||
- content.code.select | ||
- navigation.footer | ||
palette: | ||
# Palette toggle for dark mode | ||
- scheme: slate | ||
toggle: | ||
icon: material/brightness-4 | ||
name: Switch to light mode | ||
# Palette toggle for light mode | ||
- scheme: default | ||
toggle: | ||
icon: material/brightness-7 | ||
name: Switch to dark mode | ||
|
||
site_url: https://rimsschemedrawer.readthedocs.io | ||
repo_url: https://github.com/RIMS-Code/RIMSSchemeDrawer | ||
site_author: Reto Trappitsch | ||
|
||
markdown_extensions: | ||
- admonition | ||
- pymdownx.superfences: | ||
custom_fences: | ||
- name: mermaid | ||
class: mermaid | ||
format: !!python/name:pymdownx.superfences.fence_code_format | ||
- pymdownx.highlight: | ||
anchor_linenums: true | ||
line_spans: __span | ||
pygments_lang_class: true | ||
- pymdownx.inlinehilite | ||
- pymdownx.snippets | ||
|
||
|
||
plugins: | ||
- search | ||
|
||
nav: | ||
- Home: index.md | ||
- Installation: install.md | ||
- GUI: gui.md | ||
- API: | ||
- Overview: api/index.md |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters