lass_j/AMBER
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity

Move badges

Browse Source 
Add contribution
Add contact
Move tutorials higher up
This commit is contained in:
Jakob Lass 2025-04-14 09:29:41 +02:00
parent 0933ff775e
commit b135aa16e7
1 changed files with 35 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
source/index.rst
View File

@ -5,6 +5,21 @@
AMBER documentation AMBER documentation
=================== ===================
.. image:: https://gitea.psi.ch/lass_j/AMBER/actions/workflows/test.yaml/badge.svg
:height: 20
:alt: Test Status
.. image:: https://readthedocs.org/projects/AMBER-ds4ms/badge/?style=plastic
:height: 20
:alt: Read the Docs
.. image:: https://img.shields.io/pypi/v/AMBER-ds4ms
:height: 20
:alt: PyPI - Version
.. image:: https://img.shields.io/pypi/pyversions/AMBER-ds4ms
:height: 20
:alt: PyPI - Python Version
This is the documentation for the **A** lgorithm for **M** ultiplexing spectrometer This is the documentation for the **A** lgorithm for **M** ultiplexing spectrometer
**B** ackground **E** stimation with **R** otation-independence **AMBER** which is a method to estimate and background within 3D data sets. **B** ackground **E** stimation with **R** otation-independence **AMBER** which is a method to estimate and background within 3D data sets.
@ -14,16 +29,6 @@ This software is the result of the collaboration between the instrument responsi
the fifth call for Collaborative Research Data Science Projects. the fifth call for Collaborative Research Data Science Projects.
Badges
------
.. image:: https://gitea.psi.ch/lass_j/AMBER/actions/workflows/test.yaml/badge.svg
:width: 50
:alt: Test Status
Installation Installation
@ -40,6 +45,19 @@ Alternatively, the newest version can be installed directly from the source repo
python -m pip install git+https://gitea.psi.ch/lass_j/AMBER.git@main python -m pip install git+https://gitea.psi.ch/lass_j/AMBER.git@main
Documentation & Tutorials
-------------------------
For **AMBER** the following tutorials have been created
.. toctree::
:maxdepth: 2
:caption: Contents:
tutorials/index.rst
General Introduction General Introduction
-------------------- --------------------
@ -66,29 +84,19 @@ the radial :math:`b` to the full space. These three parameters constitute the fi
For further details, see the the paper. For further details, see the the paper.
Documentation & Tutorials
-------------------------
For **AMBER** the following tutorials have been created
.. toctree::
:maxdepth: 2
:caption: Contents:
tutorials/index.rst
Contribute Contribute
---------- ----------
This project is more than happy for contribution to the code base. However, it is recommended that before a large commitment and/pull request is made,
please do contact the `maintainers`_ or open an `issue`_.
Contact Contact
------- -------
Contact to the maintainers is recommended through either an `issue`_ or by sending an email to the `maintainers`_.
.. _maintainers: mailto:jakob.lass@psi.ch
.. _issue: https://gitea.psi.ch/lass_j/AMBER/issues