Skip to content
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.

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

Update CITATION.cff #940

Merged
merged 4 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
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
1 change: 1 addition & 0 deletions .github/workflows/ci.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ jobs:
- name: "Setup Micromamba"
uses: mamba-org/setup-micromamba@v1
with:
micromamba-version: '1.5.6-0'
micromamba-binary-path: ~/.local/bin/micromamba
environment-file: environment.yml
environment-name: openfe_env
Expand Down
10 changes: 8 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,15 @@ authors:
- given-names: "David"
family-names: "Dotson"
orcid: "https://orcid.org/0000-0001-5879-2942"
- given-names: Joshua T.
family-names: Horton
orcid: 'https://orcid.org/0000-0001-8694-7200'
- given-names: Matthew
family-names: Thompson
orcid: 'https://orcid.org/0000-0002-1460-3983'
title: "The Open Free Energy library"
version: 1.0
date-released: 2024-04-19
version: 1.1.0
date-released: 2024-09-25
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do I need to update the doi?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pretty sure I have the DOI setup to point to "latest" I will check!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From zenodo:

Cite all versions? You can cite all versions by using the DOI 10.5281/zenodo.8344247. This DOI represents all versions, and will always resolve to the latest one. Read more.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

so no need to update the DOI

url: "https://openfree.energy/"
repository-code: "https://github.com/openfreeEnergy/openfe"
doi: 10.5281/zenodo.8344247
35 changes: 35 additions & 0 deletions docs/CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,41 @@ Changelog

.. current developments

v1.1.0
====================

**Added:**

* Extended system solvation tooling, including support for; non-cubic boxes,
explicitly defining the number of waters added, the box vectors, and box size
as supported by `Modeller.addSolvent` in OpenMM 8.0 and above.

**Changed:**

* Improved documentation of the OpenMMSolvationSettings.
* The `PersesAtomMapper` now uses openff.units inline with the rest of the package.
* Structural analysis data is no longer written to `structural_analysis.json`
but rather a 32bit numpy compressed file named `structural_analysis.npz`
(PR #937).
* Structural analysis array data is no longer directly returned in the
RelativeHybridTopologyProtocol result dictionary. Instead it should
be accessed from the serialized NPZ file `structural_analysis.npz`.
The `structural_analysis` key now contains a path to the NPZ file,
if the structural analysis did not fail (the `structural_analysis_error`
key will instead be present on failure) (PR #937).
* Add duecredit citations for pymbar when calling
`openfe.protocols.openmm_utils.multistate_analysis`.

**Fixed:**

* 2D RMSD plotting now allows for fewer than 5 states (PR #896).
* 2D RMSD plotting no longer draws empty axes when
the number of states - 1 is not divisible by 4 (PR #896).
* The RelativeHybridTopologyProtocol result unit is now much smaller,
due to the removal of structural analysis data (PR #937).



v1.0.1
====================

Expand Down
25 changes: 0 additions & 25 deletions news/noncubic_solvent.rst

This file was deleted.

25 changes: 0 additions & 25 deletions news/pr_896.rst

This file was deleted.

23 changes: 0 additions & 23 deletions news/pr_930.rst

This file was deleted.

32 changes: 0 additions & 32 deletions news/pr_937.rst

This file was deleted.

24 changes: 0 additions & 24 deletions news/pymbar_duecredit.rst

This file was deleted.

Loading