Skip to content

Commit

Permalink
add citation info in README
Browse files Browse the repository at this point in the history
  • Loading branch information
navidcy authored Feb 28, 2024
1 parent 337fde4 commit f686d3e
Showing 1 changed file with 22 additions and 1 deletion.
23 changes: 22 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,4 +79,25 @@ psi = animate_iteration(invert_Poisson, vor, iParams=iParams,
loop_per_frame=1, max_frames=40)
```

See the animation at the top.
See the animation at the top.



## 5 Cite

If you use the package in research, teaching, or other activities, we would be grateful
if you mention `xinvert` and cite our paper in JOSS:

```bibtex
@article{Qian2023,
doi = {10.21105/joss.05510},
url = {https://doi.org/10.21105/joss.05510},
year = {2023},
publisher = {The Open Journal},
volume = {8},
number = {89},
pages = {5510},
author = {Yu-Kun Qian},
title = {xinvert: A Python package for inversion problems in geophysical fluid dynamics}, journal = {Journal of Open Source Software}
}
```

0 comments on commit f686d3e

Please sign in to comment.