Skip to content

Commit

Permalink
Update README and readthedocs.yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
MatthewFilipovich committed May 29, 2024
1 parent e722613 commit 83fa91f
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 6 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ PyCharge was developed to allow both novice and experienced users model a wide r
- Moving dipoles can be modelled by specifying the dipole's origin position as a function of time.
- 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.

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.
Our research paper, published in [Computational Physics Communications](https://doi.org/10.1016/j.cpc.2022.108291) and available on [arXiv](https://arxiv.org/abs/2107.12437), introduces the PyCharge package and provides a comprehensive review of the rich physics that govern the coupled dipole simulations.

## Documentation

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

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

## License

Expand Down
2 changes: 1 addition & 1 deletion docs/docs_requirements.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
mkdocs-material==7.1.5
python-markdown-math==0.8
mkdocstrings==0.15.1
mkdocstrings-python==1.10.3
numpy==1.20.3
dill==0.3.3
scipy==1.6.3
Expand Down
4 changes: 2 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ PyCharge was developed to allow both novice and experienced users model a wide r
- Moving dipoles can be modelled by specifying the dipole's origin position as a function of time.
- 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.

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.
Our research paper, published in [Computational Physics Communications](https://doi.org/10.1016/j.cpc.2022.108291) and available on [arXiv](https://arxiv.org/abs/2107.12437), introduces the PyCharge package and provides a comprehensive review of the rich physics that govern the coupled dipole simulations.

## Usage

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

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

## License

Expand Down
8 changes: 7 additions & 1 deletion readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,9 +1,15 @@
version: 2

# Optional: Specify build environment details
build:
os: "ubuntu-22.04"
tools:
python: "3.7"

python:
version: 3.7
install:
- requirements: docs/docs_requirements.txt

mkdocs:
configuration: mkdocs.yml
configuration: mkdocs.yml

0 comments on commit 83fa91f

Please sign in to comment.