Skip to content

Commit

Permalink
Add new citation info
Browse files Browse the repository at this point in the history
  • Loading branch information
ml-evs committed Oct 14, 2023
1 parent b356127 commit 0c9f47e
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 2 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ It is written entirely in Python, using plotly to visualise the data, and is als
The code is available at [MJCliffe/PASCal](https://github.com/MJCliffe/PASCal) on GitHub, and the documentation at [docs.pascalapp.co.uk](https://docs.pascalapp.co.uk).
Installation instructions can be found [below](#offline-installation), and example Jupyter notebooks showcasing the functionality can be found in `./examples` folder on GitHub, or in the online documentation.

A paper summarising the original motivation and theory behind PASCal is published at [J. Appl. Cryst. (2012). 45, 1321-1329](https://doi.org/10.1107/S0021889812043026) ([arXiv](http://arxiv.org/pdf/1204.3007.pdf)). Please cite this if you use PASCal in a publication. This publication was produced for a previous version of PASCal and so description of the software itself is out of date. PASCal as designed might not be the most appropriate method for full analysis of your data, so please read the sections below on [errors](#errors), [fitting](#fitting) and [strains](#strain-calculation) if you have particular needs.
PASCal as designed might not be the most appropriate method for full analysis of your data, so please read the sections below on [errors](#errors), [fitting](#fitting) and [strains](#strain-calculation) if you have particular needs.

## How to cite

A paper summarising the original motivation and theory behind PASCal is published at [J. Appl. Cryst. (2012). 45, 1321-1329](https://doi.org/10.1107/S0021889812043026) ([arXiv](http://arxiv.org/pdf/1204.3007.pdf)).

If you use PASCal v2+ in a publication, please cite the latest published description of the software: [Lertkiattraku *et al.*, Journal of Open Source Software (2023)](https://joss.theoj.org/papers/3bfe66743c9a86f34d3c1b2f17906261).

# Quick start

Expand Down
3 changes: 2 additions & 1 deletion src/PASCal/templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -295,7 +295,8 @@ <h2>Options</h2>
Developed by Monthakan Lertkiattrakul and <a class="link" href="https://cliffe.nottingham.ac.uk/">Matthew Cliffe</a> at the University of Nottingham, with contributions from <a href="https://ml-evs.science">Matthew Evans</a>,
based off the <a href="http://pascal.chem.ox.ac.uk/">original version</a> developed by Matthew Cliffe and <a href="http://goodwin.chem.ox.ac.uk/">Andrew Goodwin</a> at the University of Oxford.
The code and further information is available on GitHub at <a class="link" href = "https://github.com/MJCliffe/PASCal"><i class="fa-brands fa-github"></i> MJCliffe/PASCal</a>, and bugs, errors or feature requests can also be <a href="https://github.com/MJCliffe/PASCal/blob/Live/CONTRIBUTING.md">submitted.</a> Additional comments please email Matthew.Cliffe[at]nottingham.ac.uk <br />
Please cite <a class="link" href="http://dx.doi.org/10.1107/S0021889812043026">M.J. Cliffe and A.L. Goodwin, J. Appl. Cryst. (2012). 45, 1321-1329</a>.
Please cite <a class="link" href="https://joss.theoj.org/papers/3bfe66743c9a86f34d3c1b2f17906261"><i class="ai ai-doi"></i>Lertkiattrakul <i>et al.</i>, PASCal Python: Principal Axis Strain Calculator, JOSS (2023).</a>
For more background and methods, please cite <a class="link" href="http://dx.doi.org/10.1107/S0021889812043026"><i class="ai ai-doi"></i>M.J. Cliffe and A.L. Goodwin, J. Appl. Cryst. (2012). 45, 1321-1329</a>.
The preprint is available at <a class="link" href="http://arxiv.org/abs/1204.3007"><i class="ai ai-arxiv"></i>arXiv:1204.3007</a>.
</div>
</div>
Expand Down

0 comments on commit 0c9f47e

Please sign in to comment.