Skip to content

Commit 8b87cdb

Browse files
Update documentation with Comput. Phys. Commun ref
1 parent df08aef commit 8b87cdb

File tree

2 files changed

+12
-10
lines changed

2 files changed

+12
-10
lines changed

docs/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ PyCharge was developed to allow both novice and experienced users model a wide r
1616
- Moving dipoles can be modelled by specifying the dipole's origin position as a function of time.
1717
- Parallelized version of the dipole simulation method using [mpi4py](https://mpi4py.readthedocs.io/en/stable/) to enable the parallel execution of computationally demanding simulations on high performance computing environments to significantly improve run time.
1818

19-
Our computational physics paper introducing the PyCharge package is available on [arXiv](https://arxiv.org/abs/2107.12437) and includes an extensive review of the rich physics that govern the coupled dipole simulations.
19+
Our computational physics paper introducing the PyCharge package was published in [Computer Physics Communications](https://doi.org/10.1016/j.cpc.2022.108291) and is also available on [arXiv](https://arxiv.org/abs/2107.12437). The paper includes an extensive review of the rich physics that govern the coupled dipole simulations.
2020

2121
## Usage
2222

@@ -59,7 +59,7 @@ simulation.run(timesteps, dt, 's_dipoles.dat')
5959

6060
## Download and Installation
6161

62-
The PyCharge [source repository](https://github.com/MatthewFilipovich/pycharge) is hosted on GitHub, and installation instructions are given [here](getting_started/installation.md).
62+
The PyCharge [source repository](https://github.com/MatthewFilipovich/pycharge) is hosted on GitHub and installation instructions are given [here](getting_started/installation.md).
6363

6464
## Contributing
6565

@@ -76,7 +76,7 @@ We welcome all bug reports and suggestions for future features and enhancements,
7676
If you are using PyCharge for research purposes, we kindly request that you cite the following paper:
7777

7878
M. Filipovich and S. Hughes, [PyCharge: An open-source Python package for self-consistent electrodynamics
79-
simulations of Lorentz oscillators and moving point charges](https://arxiv.org/abs/2107.12437), arXiv:2107.12437.
79+
simulations of Lorentz oscillators and moving point charges](https://arxiv.org/abs/2107.12437), Comput. Phys. Commun. 274, 108291 (2022).
8080

8181
## License
8282

pycharge/__init__.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,13 @@
99
def cite():
1010
"""Print BibTeX citation for the `pycharge` package."""
1111
citation = """@article{pycharge,
12-
title={{P}y{C}harge: An open-source Python package for self-consistent electrodynamics simulations of Lorentz oscillators and moving point charges},
13-
author={Matthew J. Filipovich and Stephen Hughes},
14-
year={2021},
15-
eprint={2107.12437},
16-
archivePrefix={arXiv},
17-
primaryClass={physics.comp-ph}
12+
title = {{PyCharge}: {An} open-source {Python} package for self-consistent electrodynamics simulations of {Lorentz} oscillators and moving point charges},
13+
author = {Filipovich, Matthew J. and Hughes, Stephen},
14+
journal = {Computer Physics Communications},
15+
volume = {274},
16+
pages = {108291},
17+
year = {2022},
18+
doi = {10.1016/j.cpc.2022.108291},
19+
url = {https://doi.org/10.1016/j.cpc.2022.108291},
1820
}"""
19-
print(citation)
21+
print(citation)

0 commit comments

Comments
 (0)