Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): add basic citation information #129

Merged
merged 8 commits into from
Oct 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
cff-version: "1.2.0"
authors:
- family-names: Eertmans
given-names: Jérome
orcid: "https://orcid.org/0000-0002-5579-5360"
doi: 10.5281/zenodo.13895021
message: If you use this software, please cite us.
repository-code: 'https://github.com/jeertmans/DiffeRT'
license: MIT
version: v0.0.20
type: software
url: 'https://eertmans.be/DiffeRT
abstract: >-
Differentiable Ray Tracer for Radio-Propagation Modeling.
keywords:
- Ray Tracing
- Differentiable
- JAX
- Radio Propagation
- Modeling
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,12 +123,17 @@ or benchmark it:
pytest --benchmark-enable differt/tests/benchmarks
```

## Citing

If you use this software, please cite it as
[detailed here](https://differt.readthedocs.io/latest/citing.html).

[pypi-version-badge]: https://img.shields.io/pypi/v/DiffeRT?label=DiffeRT&color=blueviolet
[pypi-version-url]: https://pypi.org/project/DiffeRT/
[pypi-python-version-badge]: https://img.shields.io/pypi/pyversions/DiffeRT?color=orange
[documentation-badge]: https://readthedocs.org/projects/differt/badge/?version=latest
[documentation-url]: https://differt.readthedocs.io/latest/?badge=latest
[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.11386432.svg
[doi-url]: https://doi.org/10.5281/zenodo.11386432
[doi-badge]: https://zenodo.org/badge/DOI/10.5281/zenodo.13895021.svg
[doi-url]: https://doi.org/10.5281/zenodo.13895021
[codecov-badge]: https://codecov.io/gh/jeertmans/DiffeRT/branch/main/graph/badge.svg?token=v63alnTWzu
[codecov-url]: https://codecov.io/gh/jeertmans/DiffeRT
11 changes: 11 additions & 0 deletions docs/source/citing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
.. _citing:

Citing
======

If you use this software, please cite us using the
`Cite this repository <https://github.com/jeertmans/DiffeRT>`_
button the main page of our Github repository.
This will provide you with the preferred citation.

Thank you for using this software and helping us!
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@ DiffeRT: Differentiable Ray Tracing Toolbox for Radio Propagation
notebooks/type_checking
notebooks/performance_tips
notebooks/path_candidates
citing
references
Loading
Loading