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

1.0.0 release #68

Merged
merged 128 commits into from
Nov 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
128 commits
Select commit Hold shift + click to select a range
c92099b
Add output module
martimunicoy Sep 4, 2020
d27eb62
Merge branch 'devel' into dynamic_paths
martimunicoy Sep 14, 2020
f5f70a5
Implement OutputPathHandler
martimunicoy Sep 15, 2020
68bd07b
Extend dihedral compatibility
martimunicoy Sep 22, 2020
5bf632b
Minor bug fix
martimunicoy Sep 22, 2020
2ebd45f
Minor change in the format of the new Impact file
martimunicoy Sep 22, 2020
66a2154
Fix wrong format when including phase constant to Impact file
martimunicoy Sep 22, 2020
9c76113
Incorporation of phase constant to dihedral plot
martimunicoy Sep 23, 2020
6eea90f
Add core constraints example
martimunicoy Oct 15, 2020
255e706
Class to constrain atom in core
martimunicoy Oct 15, 2020
cd2e5a6
Tests for core constraint utility
martimunicoy Oct 15, 2020
540333c
Update docstring examples
martimunicoy Oct 15, 2020
25ac2d8
Minor fix in an exception raising
martimunicoy Oct 15, 2020
8358461
Merge branch 'master' into molecular_graph_with_constrained_core
martimunicoy Oct 15, 2020
1c03f6e
Update releasehistory.rst
martimunicoy Oct 15, 2020
6bee611
Merge pull request #62 from martimunicoy/molecular_graph_with_constra…
martimunicoy Oct 15, 2020
2200cc9
Allow multiple atom constraints
martimunicoy Oct 15, 2020
df9ac3d
Merge branch 'molecular_graph_with_constrained_core' of https://githu…
martimunicoy Oct 15, 2020
66c2174
Add side chain perturbation example
martimunicoy Oct 15, 2020
b31a97c
Update releasehistory.rst
martimunicoy Oct 15, 2020
fa25f6c
Merge pull request #63 from martimunicoy/molecular_graph_with_constra…
martimunicoy Oct 15, 2020
22fc49e
Minor corrections related with dihedrals
martimunicoy Oct 15, 2020
e5bcd96
Add test for non standard dihedrals
martimunicoy Oct 15, 2020
d9180d5
Merge branch 'full_dihedral_compatibility' of https://github.com/mart…
martimunicoy Oct 15, 2020
ad324ec
Update releasehistory.rst
martimunicoy Oct 15, 2020
1bc4ee6
Remove idivf restriction for propers
martimunicoy Oct 15, 2020
2533541
Add 5 to accepted periodicity values
martimunicoy Oct 15, 2020
a795f04
Merge branch 'full_dihedral_compatibility' of https://github.com/mart…
martimunicoy Oct 15, 2020
896a705
Handle inconsistency of test_conformer_setter
martimunicoy Oct 15, 2020
b7ae0c2
Minor fix
martimunicoy Oct 15, 2020
d548368
Merge pull request #66 from martimunicoy/full_dihedral_compatibility
martimunicoy Oct 15, 2020
83790af
First changes to implement different forcefields
martimunicoy Oct 16, 2020
d711719
Update sidechain perturbation example
martimunicoy Oct 16, 2020
df9713a
Add todo in Impact class
martimunicoy Oct 16, 2020
b29ebd4
Implement forcefield and parameter wrappers classes
martimunicoy Oct 16, 2020
228e19d
Fix bond tests
martimunicoy Oct 16, 2020
b49e32b
Fix angle tests
martimunicoy Oct 18, 2020
5b58d98
Migration of OPLS2005 code
martimunicoy Oct 18, 2020
5583445
Force field setter for molecule class
martimunicoy Oct 19, 2020
83a338a
Update charge classes to new force field methods
martimunicoy Oct 19, 2020
0679fd1
Add forcefield module
martimunicoy Oct 19, 2020
71a4a0b
Add data for tests
martimunicoy Oct 19, 2020
f3c01a0
Minor bug fix in get_data_file_path
martimunicoy Oct 19, 2020
53461ec
Fix and remove deprecated tests
martimunicoy Oct 19, 2020
aab339b
Remove print
martimunicoy Oct 19, 2020
6a9fd5e
Propers and impropers from OPLS2005
martimunicoy Oct 19, 2020
5124cf6
Tests for force fields and parameters
martimunicoy Oct 19, 2020
6e9f8b7
Add OpenFFOPLS2005ForceField to docs
martimunicoy Oct 19, 2020
337d823
Clever handling of force field parameters
martimunicoy Oct 19, 2020
cf204fd
Fix several issue in OpenFFOPLS2005ForceField
martimunicoy Oct 19, 2020
e709c38
Fix bug in OpenFFOPLS2005ForceField
martimunicoy Oct 19, 2020
66d2395
Add tests for TestOpenFFOPLS2005ForceField
martimunicoy Oct 19, 2020
d6eac47
Add option to force reparameterization
martimunicoy Oct 19, 2020
ca27774
Fix usage of ffld_server output
martimunicoy Oct 19, 2020
c0bb0f5
Update releasehistory.rst
martimunicoy Oct 19, 2020
68b17bd
Remove references to deprecated parameterization options
martimunicoy Oct 19, 2020
e330cde
Remove unused imports
martimunicoy Oct 19, 2020
802cf55
Minor changes
martimunicoy Oct 19, 2020
af103d4
Remove unused import
martimunicoy Oct 19, 2020
7e0a70f
Remove unused imports
martimunicoy Oct 19, 2020
4adc482
Fix unnecessary assignments
martimunicoy Oct 19, 2020
034e968
Fix unnecessary assignments
martimunicoy Oct 19, 2020
c086d35
Merge pull request #69 from martimunicoy/opls2005
martimunicoy Oct 19, 2020
fd75656
Remove unused imports
martimunicoy Oct 19, 2020
71596c1
Fix conflicts
martimunicoy Oct 19, 2020
0e98d9c
Add missing files for tests
martimunicoy Oct 19, 2020
9ee46bc
Merge branch 'devel' into dynamic_paths
martimunicoy Oct 19, 2020
6fca5ca
Better diff display for python files
martimunicoy Oct 19, 2020
931d845
Fix tests and old deprecated references
martimunicoy Oct 19, 2020
79e14a6
Add tests for main.py
martimunicoy Oct 20, 2020
aea006f
Add tests for output_handler
martimunicoy Oct 20, 2020
8bba947
Update releasehistory.rst
martimunicoy Oct 20, 2020
1b7ca1e
Merge pull request #70 from martimunicoy/argparse_enhancement
martimunicoy Oct 20, 2020
7c7a2b1
as_DataLocal argument is replaced by as_datalocal
martimunicoy Oct 20, 2020
d0e0d43
Update releasehistory.rst
martimunicoy Oct 20, 2020
e7c0aef
Minor fix
martimunicoy Oct 20, 2020
016371e
Merge branch 'dynamic_paths' of https://github.com/martimunicoy/offpe…
martimunicoy Oct 20, 2020
d1ab941
Correct failing test
martimunicoy Oct 20, 2020
ca16d6c
Merge pull request #56 from martimunicoy/dynamic_paths
martimunicoy Oct 20, 2020
672f581
Update examples
martimunicoy Oct 20, 2020
cc1b74a
Fix bug in OPLSChargeCalculator
martimunicoy Oct 20, 2020
283e044
Revert "Update examples"
martimunicoy Oct 20, 2020
08ae1a6
Revert "Fix bug in OPLSChargeCalculator"
martimunicoy Oct 20, 2020
275d749
Revert "Fix bug in OPLSChargeCalculator"
martimunicoy Oct 20, 2020
a0b01da
Fix bug in OPLSChargeCalculator
martimunicoy Oct 20, 2020
319baaa
Merge branch 'dynamic_paths' into devel
martimunicoy Oct 20, 2020
c0b8608
Merge branch 'devel' of https://github.com/martimunicoy/offpele into …
martimunicoy Oct 20, 2020
56411fd
Remove unnecessary pdb file
martimunicoy Oct 20, 2020
19ee4dc
Update examples
martimunicoy Oct 20, 2020
8e4367c
Update examples
martimunicoy Oct 20, 2020
930a68b
Fix bug in OPLSChargeCalculator
martimunicoy Oct 20, 2020
029b1f6
Update example
martimunicoy Oct 20, 2020
b3da148
Add examples data
martimunicoy Oct 20, 2020
003da19
Update sidechain_perturbation_template example
martimunicoy Oct 20, 2020
9f5585e
Fixes for the opls2005 implementation
martimunicoy Oct 21, 2020
5ca2bd3
Update releasehistory.rst
martimunicoy Oct 21, 2020
c9317b7
Merge pull request #74 from martimunicoy/opls_fixes
martimunicoy Oct 21, 2020
4429912
First test for class Impact
laumalo Oct 30, 2020
49ece17
Fix and tests
martimunicoy Oct 30, 2020
e671476
Update releasehistory.rst
martimunicoy Oct 30, 2020
4c415d1
Merge pull request #79 from martimunicoy/missing_module_fix
martimunicoy Oct 30, 2020
8a3a7ea
Fix for OPLS propers
martimunicoy Oct 30, 2020
f3c1c98
Complete fix solving wrong types
martimunicoy Oct 30, 2020
515af79
Update releasehistory.rst
martimunicoy Oct 30, 2020
7c74b0e
Test for dummy propers
martimunicoy Oct 30, 2020
f646aee
Merge branch 'fix_OPLS_propers' of https://github.com/martimunicoy/of…
martimunicoy Oct 30, 2020
b215df5
Merge pull request #82 from martimunicoy/fix_OPLS_propers
martimunicoy Oct 30, 2020
ba87580
Add data for new dummy propers test
martimunicoy Oct 30, 2020
25efb0e
Merge branch 'devel' of https://github.com/martimunicoy/offpele into …
martimunicoy Oct 30, 2020
d9c6879
Modified test_writer
laumalo Nov 2, 2020
caf6897
Improved TestImpactTemplate
laumalo Nov 2, 2020
7b7fde4
Add test_writer_OPLS
laumalo Nov 2, 2020
77987b9
Minor changes in TestImpactTemplate
laumalo Nov 2, 2020
7d0451e
Update releasehistory.rst
martimunicoy Nov 2, 2020
3ca6a1b
Merge branch 'devel' into test_Templates
martimunicoy Nov 2, 2020
87d7e3c
Follow PEP8 styling
martimunicoy Nov 2, 2020
5672009
Fix bug that prevented a non-parameterized Molecule to be detected
martimunicoy Nov 2, 2020
7fa5d75
Merge pull request #84 from martimunicoy/test_Templates
martimunicoy Nov 2, 2020
06d25dd
Update releasehistory.rst
martimunicoy Nov 2, 2020
5b7eaf3
Replace offpele with peleffy
martimunicoy Nov 2, 2020
df29926
Update README.md
martimunicoy Nov 2, 2020
13d3132
Update README.md
martimunicoy Nov 2, 2020
eb48fd2
Update package description
martimunicoy Nov 2, 2020
1782a65
Merge pull request #85 from martimunicoy/peleffy_rename
martimunicoy Nov 2, 2020
d33b709
Update releasehistory.rst
martimunicoy Nov 2, 2020
56256d9
Replace offpele with peleffy
martimunicoy Nov 2, 2020
1c41b95
Update releasehistory.rst
martimunicoy Nov 2, 2020
c179d91
Update setup.py
martimunicoy Nov 2, 2020
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 .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
offPELE/_version.py export-subst
*.py diff=python
4 changes: 2 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
conda info
conda list

- name: Install offpele
- name: Install peleffy
shell: bash -l {0}
run: |
python -m pip install --no-deps -v .
Expand All @@ -51,7 +51,7 @@ jobs:
- name: Test with pytest
shell: bash -l {0}
run: |
pytest -r fE --tb=short --cov=offpele --cov-config=setup.cfg offpele/
pytest -r fE --tb=short --cov=peleffy --cov-config=setup.cfg peleffy/

- name: Codecov
shell: bash -l {0}
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
include versioneer.py
include offpele/_version.py
include peleffy/_version.py
14 changes: 8 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,12 @@
| **About** | [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![Python](https://img.shields.io/badge/python-3.6%2C%203.7-blue.svg)](https://martimunicoy.github.io/offpele) [![Release](https://img.shields.io/github/release/martimunicoy/offpele.svg?include_prereleases)](https://github.com/martimunicoy/offpele/releases/) |
| **About** | [![License](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE) [![Python](https://img.shields.io/badge/python-3.6%2C%203.7-blue.svg)](https://martimunicoy.github.io/peleffy) [![Release](https://img.shields.io/github/release/martimunicoy/peleffy.svg?include_prereleases)](https://github.com/martimunicoy/peleffy/releases/) |
| :------ | :------- |
| **Status** | [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/martimunicoy/offpele.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/martimunicoy/offpele/context:python) [![Test](https://github.com/martimunicoy/offpele/workflows/Test/badge.svg)](https://github.com/martimunicoy/offpele/actions?query=workflow%3ATest) [![codecov](https://codecov.io/gh/martimunicoy/offpele/branch/master/graph/badge.svg)](https://codecov.io/gh/martimunicoy/offpele) |
| **Installation** | [![Conda](https://img.shields.io/conda/v/martimunicoy/offpele.svg)](https://anaconda.org/martimunicoy/offpele) [![PyPI](https://img.shields.io/pypi/v/offpele)](https://pypi.org/project/offpele/) |
| **Status** | [![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/martimunicoy/peleffy.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/martimunicoy/peleffy/context:python) [![Test](https://github.com/martimunicoy/peleffy/workflows/Test/badge.svg)](https://github.com/martimunicoy/peleffy/actions?query=workflow%3ATest) [![codecov](https://codecov.io/gh/martimunicoy/peleffy/branch/master/graph/badge.svg)](https://codecov.io/gh/martimunicoy/peleffy) |
| **Installation** | [![Conda](https://img.shields.io/conda/v/martimunicoy/peleffy.svg)](https://anaconda.org/martimunicoy/peleffy) [![PyPI](https://img.shields.io/pypi/v/peleffy)](https://pypi.org/project/peleffy/) |

# Open Force Field to PELE
The `offpele` (Open Force Field to PELE) is a Python package that builds [PELE](https://pele.bsc.es/pele.wt)-compatible force field templates using the [Open Force Field toolkit](https://github.com/openforcefield/openforcefield).
# PELE Force Field Yielder
The `peleffy` (PELE Force Field Yielder) is a Python package that builds [PELE](https://pele.bsc.es/pele.wt)-compatible force field templates. The current supported force fields are:
- Any force field from the [Open Force Field toolkit](https://github.com/openforcefield/openforcefield).
- OPLS2005.

## Documentation
The documentation for the `offpele` package is available at [GitHub Pages](https://martimunicoy.github.io/offpele).
The documentation for the `peleffy` package is available at [GitHub Pages](https://martimunicoy.github.io/peleffy).
4 changes: 2 additions & 2 deletions devtools/conda/meta.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{% set data = load_setup_py_data() %}

package:
name: offpele
name: peleffy
version: {{ data.get('version') }}

source:
Expand Down Expand Up @@ -29,5 +29,5 @@ requirements:
- openforcefield==0.7.1

about:
home: https://github.com/martimunicoy/offpele
home: https://github.com/martimunicoy/peleffy
license: MIT
2 changes: 1 addition & 1 deletion docs/charge.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Charge methods
This module provides different methods to calculate partial charges
for PELE.

.. currentmodule:: offpele.charge
.. currentmodule:: peleffy.charge

Primary objects
---------------
Expand Down
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ def add_source_parser(_old_add_source_parser, self, *args, **kwargs):
source_suffix = ['.rst', '.md']
master_doc = 'index'

import offpele
version = offpele.__version__
import peleffy
version = peleffy.__version__

pygments_style = 'sphinx'

Expand Down
21 changes: 21 additions & 0 deletions docs/forcefield.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
.. _forcefield ::

Forcefield methods
==============

This module defines the different force fields that are available
to parameterize molecules for PELE.

.. currentmodule:: peleffy.forcefield

Primary objects
---------------

.. autosummary::
:nosignatures:
:toctree: api/autogenerated
:template: class.rst

OpenForceField
OPLS2005ForceField
OpenFFOPLS2005ForceField
13 changes: 8 additions & 5 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
Open Force Field for PELE
=========================
PELE Force Field Yielder
========================

The Open Force Field for PELE is a Python package that builds
PELE-compatible force field templates using the Open Force Field
toolkit.
The `peleffy` (PELE Force Field Yielder) is a Python package that builds
PELE-compatible force field templates. The current supported force fields
are:
- Any force field from the [Open Force Field toolkit](https://github.com/openforcefield/openforcefield).
- OPLS2005.


User guide
Expand All @@ -28,3 +30,4 @@ API documentation
template
solvent
charge
forcefield
32 changes: 16 additions & 16 deletions docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Installation

Installing via `conda`
======================
The more straightforward way to install `offpele` along with the required
The more straightforward way to install `peleffy` along with the required
dependencies is through the `conda <http://www.continuum.io/blog/conda>`_
package manager.

Expand Down Expand Up @@ -35,45 +35,45 @@ the following commands:
$ source ~/miniconda3/etc/profile.d/conda.sh
$ conda activate base

You can also create a custom conda environment to handle offpele:
You can also create a custom conda environment to handle peleffy:

.. code-block:: bash

$ conda create --name offpele_env
$ conda create --name peleffy_env

which can be activated and deactivated with the two commands from below:

.. code-block:: bash

$ conda activate offpele_env
$ conda activate peleffy_env
$ conda deactivate

To install de dependencies of offpele, the following `conda` channels need
To install de dependencies of peleffy, the following `conda` channels need
to be added and updated:

.. code-block:: bash

$ conda config --add channels omnia --add channels conda-forge --add channels martimunicoy
$ conda update --all

Finally, you can install the latest stable build of `offpele`
Finally, you can install the latest stable build of `peleffy`

.. code-block:: bash

$ conda install offpele
$ conda install peleffy


Installing via `PyPI`
=====================

`offpele` can also be installed through `PyPI <https://pypi.org>`_
`peleffy` can also be installed through `PyPI <https://pypi.org>`_
with the following command:

.. code-block:: bash

$ pip install offpele
$ pip install peleffy

However, with `PyPI` some of the required dependencies of `offpele` are not
However, with `PyPI` some of the required dependencies of `peleffy` are not
installed and have to be installed manually such as:

- Open Force Field Toolkit
Expand All @@ -86,21 +86,21 @@ For this reason, the installation through `conda` is recommended.
External dependencies
=====================

Some of the functionalities of `offpele` require external dependencies.
Some of the functionalities of `peleffy` require external dependencies.
They are normally included with the standard `conda` installation, as
explained above. However, the Schrodinger toolkit must be installed
manually. It is only required when combining `Open Force Field` parameters
with `OPLS2005` (as it uses the Schrodinger's `ffld_server`). Nevertheless,
in case that Schrodinger dependencies are missing, `offpele` can still be
in case that Schrodinger dependencies are missing, `peleffy` can still be
employed to generate pure `Open Force Field` parameters.

The easiest way to get a valid Schrodinger installation is downloading
`Free Maestro <https://www.schrodinger.com/freemaestro>`_. It can be
installed in both platforms that are supported by `offpele`: Linux and
MacOS. Once installed, `offpele` will need an environment variable to be
installed in both platforms that are supported by `peleffy`: Linux and
MacOS. Once installed, `peleffy` will need an environment variable to be
set in order to known the Schrodinger's installation path. So, please,
check that the following environment variable is set before running
`offpele` if you plant to work with `OPLS2005` parameters:
`peleffy` if you plant to work with `OPLS2005` parameters:

.. code-block:: bash

Expand All @@ -113,7 +113,7 @@ For example, in MacOS, a typical installation path is

$ export SCHRODINGER=/opt/schrodinger/suites2020-2/

This variable must be set every time `offpele` is employed to work with
This variable must be set every time `peleffy` is employed to work with
`OPLS2005` parameters in a new console session. To avoid future concerns about
this issue, you can set the environment variable automatically every time you
initiate a bash session in your console. You can do so by modifying your
Expand Down
Loading