Skip to content

Commit 7644cdb

Browse files
committed
feat: add CITATION.cff and update README with citation, installation, and author details.
1 parent 7081bc3 commit 7644cdb

2 files changed

Lines changed: 37 additions & 3 deletions

File tree

CITATION.cff

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
cff-version: 1.2.0
2+
message: "If you use this software, please cite it as below."
3+
type: software
4+
title: "quantumhall_matrixelements: Quantum Hall Landau-Level Matrix Elements"
5+
version: "0.1.0"
6+
date-released: "2025-11-18"
7+
authors:
8+
- family-names: Wolf
9+
given-names: Tobias
10+
repository-code: "https://github.com/wolft/quantumhall_matrixelements"
11+
license: MIT
12+
abstract: >
13+
Landau-level plane-wave form factors and exchange kernels for quantum Hall systems,
14+
with multiple numerical backends and symmetry diagnostics.
15+

README.md

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# quantumhall_matrixelements
1+
# quantumhall-matrixelements: Quantum Hall Landau-Level Matrix Elements
22

33
Landau-level plane-wave form factors and exchange kernels for quantum Hall systems.
44

@@ -76,7 +76,13 @@ The package performs calculations in dimensionless units where lengths are scale
7676

7777
## Installation
7878

79-
From a local checkout:
79+
From PyPI (once published):
80+
81+
```bash
82+
pip install quantumhall-matrixelements
83+
```
84+
85+
From a local checkout (development install):
8086

8187
```bash
8288
pip install -e .[dev]
@@ -103,7 +109,15 @@ print("F shape:", F.shape)
103109
print("X shape:", X.shape)
104110
```
105111

106-
For more detailed examples, see the tests under `tests/`.
112+
For more detailed examples, see the example scripts under `examples/` and the tests under `tests/`.
113+
114+
## Citation
115+
116+
If you use the package`quantumhall-matrixelements` in academic work, please cite:
117+
118+
> Tobias Wolf, *quantumhall-matrixelements: Quantum Hall Landau-Level Matrix Elements*, version 0.1.0, 2025. DOI: to be assigned via Zenodo.
119+
120+
A machine-readable `CITATION.cff` file is included in the repository and can be used with tools that support it (for example, GitHub’s “Cite this repository” button).
107121

108122
## Development
109123

@@ -120,3 +134,8 @@ For more detailed examples, see the tests under `tests/`.
120134
mypy .
121135
```
122136

137+
## Authors and license
138+
139+
- Author: Tobias Wolf
140+
- Copyright © 2025 Tobias Wolf
141+
- License: MIT (see `LICENSE`).

0 commit comments

Comments
 (0)