https://github.com/OxfordIonTrapGroup/atomic_physics

Nascent toolkit for calculating state energies, transition matrix elements, rate equations, obe solver, etc
https://github.com/OxfordIonTrapGroup/atomic_physics

Last synced: about 1 month ago
JSON representation

Nascent toolkit for calculating state energies, transition matrix elements, rate equations, obe solver, etc

• Host: GitHub
• URL: https://github.com/OxfordIonTrapGroup/atomic_physics
• Owner: OxfordIonTrapGroup
• Created: 2018-12-04T18:12:53.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-22T05:52:17.000Z (2 months ago)
• Last Synced: 2024-05-19T00:05:46.354Z (about 2 months ago)
• Language: Python
• Size: 213 KB
• Stars: 15
• Watchers: 8
• Forks: 16
• Open Issues: 16
• Metadata Files:
  • Readme: README.md

Lists

• awesome-iontraps - ion_phys - Optical transition properties of common ion species, still in early stage - Oxford group (Software / Theory)

README

        
# Atomic Physics

## Setup

Pre-requisites:

* [Poetry ^1.1](https://python-poetry.org/)

    * `pip3 install poetry`

    * [Poe the poet task runner](https://github.com/nat-n/poethepoet)

        * `pip3 install poethepoet`

        To install dependencies and create virtual env: `poetry install`.

## Testing

* `poe test` can runs tests

* `poe flake` runs flake8.

* tests and flake must pass before PRs can be merged (master is branch protected)

## Automatic formatting

`poe fmt` will use `black` to automatically format the code