
********************************************************************************
Version 3.1.0.2
********************************************************************************

.. _section_oechem_releasenotes_3102:

OEChem TK 3.1.0.2
================================================================================

*March 2021*

* Additional metadata constants were added to
  the :ref:`OEMetadata <OEDataFlow_OEMetadata>`
  namespace for
  controlling the visibility of fields in the Orion user interface.

.. _section_oebio_releasenotes_3102:

OEBio TK 3.1.0.2
================================================================================

* The :oe:meth:`OEBio::OEReceptorCustomConstraints::GetConstraintFeatures` method is now
  properly wrapped in python.

* The :ref:`GetCustomConstraints <OEBio_OEReceptor_GetCustomConstraints>` now returns a const or
  non const ref instead of a copy

* The :oe:meth:`OEBio::OEReceptor::GetProteinConstraints` can now also return
  a non-const iterator


********************************************************************************
Version 3.1.0
********************************************************************************

OEChem TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* A new function, :oe:func:`OEChem::OEGetHydrogenCounts`, has been added that provides
  implicit and explicit hydrogen counts in a molecule.

* A new function, :oe:func:`OEChem::OEApplyStateFromRef`, has been added that provides the ability
  to apply a certain state to a molecule. This could be used to apply tautomers to a molecule in 3D
  or to fix broken valence states using a known state.

* A new function, :oe:func:`OEChem::OERGroupsToHydrogens`, has been added that converts R-groups
  of a molecule to hydrogen atoms.

* A new preliminary namespace, :oe:constns:`OEChem::OEFileStringType`, has been defined that allows controlling
  file types in :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` and :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`.

* Two new preliminary classes, :ref:`OEFileStringParameter <OEChem_OEFileStringParameter>` and :ref:`OEOutFileStringParameter <OEChem_OEOutFileStringParameter>`,
  have been added to allow better control over file types that can be used in :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>`
  and :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`.

* The constructor of the preliminary class :ref:`OESimpleAppOptions <OEChem_OESimpleAppOptions>` has been
  modified to take constants defined in :oe:constns:`OEChem::OEFileStringType` to better control
  the desired input/output file types.

* A new preliminary class, :ref:`OERefInputAppOptions <OEChem_OERefInputAppOptions>`, has been added to
  enable creating an interface to applications and scripts that require a second input,
  such as a reference or target system.

* A new method, :oe:meth:`OEBio::OEResidueCategoryData::AllInDB`, has been added that determines
  if all the specified residue names found in the list are associated with the specified category.


Minor bug fixes
--------------------------------------------------------------------------------

* An issue that occurred when a change in the aromaticity model perception would result in double bonds that should
  have lost their cis/trans parity assignments has been fixed. The bond stereo parities had been incorrectly being
  retained on aromatic atom endpoints.

* An issue with parsing SMILES with ExtBond couplings that were not honoring the convention that a specified bond
  order takes precedence over an implicit one, similar to ring closures, has been fixed.

* Extra processing has been added to ensure that a common header corruption for SDF format files throws a warning to
  indicate a format problem. In general, attempts to skip individual corrupted records in a multi-record file format
  are employed to ensure that as much of the valid input as possible can be processed. Depending on the type of corruption
  as well as the specific file format, there is no guarantee that a warning will be emitted for all corrupted records.

* An issue that caused :oe:func:`OEChem::OECopyPDBData` and :oe:func:`OEChem::OECopySDData` to avoid the copy activity if the
  source and destination molecules are the same molecule instance, which can cause a crash, has been fixed.  The status return will be false,
  just like a general failure for the copy activity.

* An issue in :oe:func:`OEChem::OEPDBOrderAtoms` that caused bad behavior when
  atoms in a molecule do not have any residue information has been fixed.


OEBio TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* Two new methods, :oe:meth:`OEBio::OEDesignUnit::HasTransform` and
  :oe:meth:`OEBio::OEDesignUnit::GetTransform`, have been added
  that check whether a valid ``OETrans`` object is stored on the ``OEDesignUnit`` and retrieve it
  for use with :oe:func:`OEBio::OETransformDesignUnit`.

* A new method, :oe:meth:`OEBio::OEMolComplexCategorizer::GetResidueCategoryData`, has been added that returns
  the non-const reference to the :ref:`OEResidueCategoryData <OEBio_OEResidueCategoryData>` stored in the
  :ref:`OEMolComplexCategorizer <OEBio_OEMolComplexCategorizer>` class.

* A new class, :ref:`OEReceptor <OEBio_OEReceptor>`, has been added that represents a
  receptor as used in **OEDocking TK**.

* A new class, :ref:`OEReceptorConstraintFeature <OEBio_OEReceptorConstraintFeature>`, has been added
  that represents a constraint feature for an :ref:`OEReceptor <OEBio_OEReceptor>`.

* A new class, :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>`, has been added
  that represents a protein constraint for an :ref:`OEReceptor <OEBio_OEReceptor>`.

* A new preliminary namespace, :oe:constns:`OEBio::OEProteinConstraintType`, has been added
  that defines the valid types for :ref:`OEReceptorProteinConstraint <OEBio_OEReceptorProteinConstraint>`.

* A new class, :ref:`OEReceptorCustomConstraints <OEBio_OEReceptorCustomConstraints>`, has been added
  that represents custom constraints for an :ref:`OEReceptor <OEBio_OEReceptor>`.

* Two new methods, :oe:meth:`OEBio::OEDesignUnit::HasReceptor` and
  :oe:meth:`OEBio::OEDesignUnit::GetReceptor`, have been added
  that check whether a valid :ref:`OEReceptor <OEBio_OEReceptor>` object is stored on the OEDesignUnit
  and retrieve it.

* Several new constants have been added to the namespace :oe:const:`OEBio::OEDesignUnitComponents`,
  related to downstream usage, such as :ref:`OEMakeReceptor <OEDocking_OEMakeReceptor>`.

Major bug fixes
--------------------------------------------------------------------------------

* A bug that caused OEDesignUnits with the Iridium Category :oe:constns:`OEBio::OEIridiumCategory::NA`
  to be assigned :oe:constns:`OEBio::OEIridiumCategory::NT` when read from a file has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* A bug in :oe:func:`OEBio::OEPlaceHydrogens` that resulted in histidine residues being in an unoptimized state,
  depending on the input state, has been fixed.

OESystem TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* A new method, :oe:meth:`OESystem::OEOptions::AddOption`, has been added that allows adding a sub-option
  to an existing :ref:`OEOptions <OESystem_OEOptions>`.

Minor bug fixes
--------------------------------------------------------------------------------

* Behavior of the field metadata on :ref:`OERecord <OEDataFlow_OERecord>` has been fixed to
  ensure that at most one field on a record can have the `ID` flag.

* An issue that caused corruption when reusing an :ref:`OERecord <OEDataFlow_OERecord>` in a loop has been fixed.


OEPlatform TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* :ref:`OEOnce <OEPlatform_OEOnce>` has been deprecated. See the **OEPlatform TK**
  documentation for alternatives.


OEGrid TK 3.1.0
================================================================================

*Fall 2020*

Major bug fixes
--------------------------------------------------------------------------------

* A bug in the symmetry operators for the I121 space group has been fixed.

Minor bug fixes
--------------------------------------------------------------------------------

* An issue that caused the function :oe:func:`OESystem::OEReadGrid` to incorrectly change the
  :oe:constns:`OESystem::OEGridType` of grids to the :oe:constns:`OESystem::OEGridFileType`,
  where it was being used to read ``OESystem::OEFizzGrid`` from a file, has been fixed.
  The :oe:constns:`OESystem::OEGridType` now remains the same through a round trip grid write and read.

* An issue that caused the function :oe:func:`OESystem::OEReadMTZ` to crash when it read large MTZ files
  and converted them to an :ref:`OESkewGrid <OESystem_OESkewGrid>` as well as computing the AMIN and AMAX statistics
  for the resulting :ref:`OESkewGrid <OESystem_OESkewGrid>` incorrectly has been fixed.
  The code has been corrected so that the crash no longer happens for large grids;
  the AMIN and AMAX calculations have also been corrected.

* An issue that caused the script :ref:`make_design_units.py<spruce_examples_make_design_units>` to crash when reading PDB files using
  the function :oe:func:`OEReadMolecule<OEChem::OEReadMolecule>`, when space group numbers that could not be
  recognized has been fixed. These space group numbers had been preventing the code from reading symmetry correctly
  from the PDB file. The code has been changed so that incorrect space group numbers result in a warning instead of a fatal crash.


OEMath TK 3.1.0
================================================================================

*Fall 2020*

New features
--------------------------------------------------------------------------------

* Two new , :ref:`OEBox <OEMath_OEBox>` and :ref:`OESphere <OEMath_OESphere>`, have
  been added that represent a box and a sphere, respectively.

* The following functions have been added as access functions to the new
  :ref:`OEBox <OEMath_OEBox>` class:

  * :oe:func:`OEMath::OEBoxArea`
  * :oe:func:`OEMath::OEBoxExtend`
  * :oe:func:`OEMath::OEBoxTranslate`
  * :oe:func:`OEMath::OEBoxVolume`
  * :oe:func:`OEMath::OEBoxXDim`
  * :oe:func:`OEMath::OEBoxXMid`
  * :oe:func:`OEMath::OEBoxYDim`
  * :oe:func:`OEMath::OEBoxYMid`
  * :oe:func:`OEMath::OEBoxZDim`
  * :oe:func:`OEMath::OEBoxZMid`
  * :oe:func:`OEMath::OEInBox`
  * :oe:func:`OEMath::OESetupBox`

* The following functions have been added as access functions to the new
  :ref:`OESphere <OEMath_OESphere>` class:

  * :oe:func:`OEMath::OEInSphere`
  * :oe:func:`OEMath::OESphereArea`
  * :oe:func:`OEMath::OESphereVolume`
