Skip to content

Add section to README about citing #57

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.

Sign up for GitHub

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

Merged
timothy-nunn merged 1 commit into from
Jun 4, 2026
Merged

Add section to README about citing #57

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
3 changes: 3 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ pip install .
## Documentation
Documentation for the VMCON algorithm and PyVMCON API/use can be found on our [**GitHub pages**](https://ukaea.github.io/PyVMCON/). The documentation includes references to the VMCON paper and other helpful resources.

## Citing PyVMCON
If you use PyVMCON in your work, please cite it using the "Cite this repository" link in the "About" section of the repository. This will cite the latest version of PyVMCON, if you are using a different release, please find the appropriate DOI on [PyVMCON's Zenodo page](https://doi.org/10.5281/zenodo.20544473).

## Testing
Tests can be run by installing the optional test dependencies `pip install 'PyVMCON[test]'` and then running `pytest tests/`. The tests check the examples from the original VMCON paper are replicated.

Expand Down
Loading