Skip to content

Commit

Permalink
docs: Add preferred citation information to README
Browse files Browse the repository at this point in the history
* List both the software repository and the EPJ Web Conf. 2021 paper.
  • Loading branch information
matthewfeickert committed Jan 30, 2025
1 parent 47b5a46 commit 523659e
Showing 1 changed file with 26 additions and 1 deletion.
27 changes: 26 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ class dd_jet:
class dd_event:
def Jets(self, bank: str) -> Iterable[dd_jet]:
...

def EventNumber(self, bank='default') -> int
...

Expand Down Expand Up @@ -204,3 +204,28 @@ For examples, see the `test_type_based_replacement` file. The class-level decora
## Development

After a new release has been built and passes the tests you can release it by creating a new release on `github`. An action that runs when a release is "created" will send it to `pypi`.

## Citation

The preferred BibTeX entry for citation of `func_adl` includes both the software repository and the EPJ Web Conf. paper:

```bibtex
@software{func_adl,
author = {Gordon Watts},
title = "{func_adl}",
url = {https://github.com/iris-hep/func_adl}
}
@article{Proffitt:2021wfh,
author = "Proffitt, Mason and Watts, Gordon",
title = "{FuncADL: Functional Analysis Description Language}",
eprint = "2103.02432",
archivePrefix = "arXiv",
primaryClass = "physics.data-an",
doi = "10.1051/epjconf/202125103068",
journal = "EPJ Web Conf.",
volume = "251",
pages = "03068",
year = "2021"
}
```

0 comments on commit 523659e

Please sign in to comment.