============================
SEAMM Read Structure Plug-in
============================
.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/read_structure_step
:target: https://github.com/molssi-seamm/read_structure_step/pulls
:alt: GitHub pull requests
.. image:: https://github.com/molssi-seamm/read_structure_step/workflows/CI/badge.svg
:target: https://github.com/molssi-seamm/read_structure_step/actions
:alt: Build Status
.. image:: https://codecov.io/gh/molssi-seamm/read_structure_step/branch/master/graph/badge.svg
:target: https://codecov.io/gh/molssi-seamm/read_structure_step
:alt: Code Coverage
.. image:: https://github.com/molssi-seamm/quickmin_step/workflows/CodeQL/badge.svg
:target: https://github.com/molssi-seamm/quickmin_step/security/code-scanning
:alt: Code Quality
.. image:: https://github.com/molssi-seamm/read_structure_step/workflows/Release/badge.svg
:target: https://molssi-seamm.github.io/read_structure_step/index.html
:alt: Documentation Status
.. image:: https://pyup.io/repos/github/molssi-seamm/read_structure_step/shield.svg
:target: https://pyup.io/repos/github/molssi-seamm/read_structure_step/
:alt: Updates for Dependencies
.. image:: https://img.shields.io/pypi/v/read_structure_step.svg
:target: https://pypi.python.org/pypi/read_structure_step
:alt: PyPi VERSION
A SEAMM plug-in to read common formats in computational chemistry
The current version uses Open Babel as an engine to parse various
formats such as PDB, Mol2 or XYZ and transform them into the SEAMM
structure format for further use in SEAMM flowcharts.
* Free software: BSD license
* Documentation: https://molssi-seamm.github.io/read_structure_step/index.html
* Code: https://github.com/molssi-seamm/read_structure_step
Features
--------
- Emphasis in ease-of-use and simplicity. The public interface
consists of a single function.
- Automatic file type recognition.
- OpenBabel as an engine to parse formats, but other engines can be
easily implemented.
- Easily extensible to new formats.
- Current support for PDB, Mol2 and XYZ files.
Example
+++++++
.. code:: python
import read_structure_step
seamm_structure = read_structure_step.read("spc.xyz")
Acknowledgements
----------------
This package was created with Cookiecutter_ and the `molssi-seamm/cookiecutter-seamm-plugin`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin
Developed by the Molecular Sciences Software Institute (MolSSI_),
which receives funding from the `National Science Foundation`_ under
award ACI-1547580
.. _MolSSI: https://www.molssi.org
.. _`National Science Foundation`: https://www.nsf.gov
=======
History
=======
2024.11.3 -- Bugfix: MOPAC files with references in comments
* Fixed a bug that caused a crash when reading MOPAC files with references in the
comments.
* Updated the MOPAC reader to the new approach for running MOPAC in the cases that
it is needed: Z-matrices and mixed inputs that OpenBabel can't handle.
2024.8.23 -- Enhancements to directory handling
* Changed the handling of paths to make them relative to the directory that the step
is running in. In a loop, for instance, files are relative to the iteration
directory.
* When reading files, allow the syntax 'job://<job number>/...' to read files from
another job. If the job number is omitted, so the prefix is 'job:///...', the top
directory of the current job is used.
2024.7.28 -- Added new names for systems and configurations
* Made the naming of systems and configurations consistent with the standard
parameters for them in the GUI.
* Removed all "from file" options, replacing them with "title", which means the title
from the file, if it exists, or the filename if it doesn't.
2023.11.16 -- Bugfix: titles in SDF files
* Crashed reading some SDF files write by SEAMM due to the system and configuration
names encoded in the title having multiple slashes (/).
2023.11.5 -- Added writers for CIF and mmCIF.
2023.11.2 -- Initial changes to structure handling
* Moving towards the standard structure handling that has developed across SEAMM.
2023.8.30 -- Support for spacegroup symmetry
2023.7.28 -- Implemented ranges for reading XYZ and SDF files.
2023.7.27.1 -- Removed debug printing.
2023.7.27 -- Support for .gz and .bz2 files, and multi-structure .xyz files
* Handle .gz and .bz2 files for .sdf and .xyz extensions.
* Handle multi-structure XYZ files with a blank line between records.
2023.7.6 -- Bugfixes
* Fixed output of number of structures written to SDF files, which was off by 1.
* Cleaned up the output for the write-structure step
2023.1.30 -- Fixed issue#43, duplicate systems or configuration created
* Reading a single structure from e.g. a .sdf file created a second system or
configuration, depending on the stucture control options.
2023.1.24 -- Added handler for XYZ files and added properties
* Added a custom handler for XYZ files to cope with some of the variant formats.
* Supports files with no atom count on the first line
* Supports the variant used in the Minnesota Solubility database, which has 3 header
lines.
* Add capability to store properties into the database for formats such as MOPAC and
SDF that can handle properties. Also can output the properties when writing the
files.
* Fixed bugs if the system name or configuration name is not a string, but rather a number.
2022.10.28 -- Fixed bug reading cif and mmcif files
* There was a bug that caused a crash when reading cif and mmcif files, and potentially
some other formats. It has been fixed throughout.
* The standard error for properties were missing a commma in the property name. The
comma is standard elsewhere in SEAMM so add it here: '<prop>, stderr'
2022.10.26 -- Handling OpenBabel error messages for MOPAC .mop files
Hiding messages about errors Kekulizing structures, which doesn't seem to be a serious
issue, and printing any other messages as warnings.
2021.2.12 (12 February 2021)
* Updated the README file to give a better description.
* Updated the short description in setup.py to work with the new installer.
* Added keywords for better searchability.
2021.2.4 (4 February 2021)
Updated for compatibility with the new system classes in MolSystem
2021.2.2 release.
2020.12.5 (5 December 2020)
Internal: switching CI from TravisCI to GitHub Actions, and in the
process moving documentation from ReadTheDocs to GitHub Pages where
it is consolidated with the main SEAMM documentation.
2020.8.1 (1 August 2020)
Removed leftover debug print statements.
0.9 (15 April 2020)
* General bug fixing and code cleanup.
* Part of release of all modules.
0.7.1 (23 November 2019)
First release on PyPI.
Raw data
{
"_id": null,
"home_page": "https://github.com/molssi-seamm/read_structure_step",
"name": "read-structure-step",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "SEAMM, plug-in, flowchart, Open Babel, molecules, atomistic, files",
"author": "Eliseo Marin-R-Rimoldi",
"author_email": "meliseo@vt.edu",
"download_url": "https://files.pythonhosted.org/packages/6c/cd/c97b4d1f9b382d9ace87657ab730e8c150d01c57039d70acc64d266a56d3/read_structure_step-2024.11.3.tar.gz",
"platform": "Linux",
"description": "============================\nSEAMM Read Structure Plug-in\n============================\n\n.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/read_structure_step\n :target: https://github.com/molssi-seamm/read_structure_step/pulls\n :alt: GitHub pull requests\n\n.. image:: https://github.com/molssi-seamm/read_structure_step/workflows/CI/badge.svg\n :target: https://github.com/molssi-seamm/read_structure_step/actions\n :alt: Build Status\n\n.. image:: https://codecov.io/gh/molssi-seamm/read_structure_step/branch/master/graph/badge.svg\n :target: https://codecov.io/gh/molssi-seamm/read_structure_step\n :alt: Code Coverage\n\n.. image:: https://github.com/molssi-seamm/quickmin_step/workflows/CodeQL/badge.svg\n :target: https://github.com/molssi-seamm/quickmin_step/security/code-scanning\n :alt: Code Quality\n\n.. image:: https://github.com/molssi-seamm/read_structure_step/workflows/Release/badge.svg\n :target: https://molssi-seamm.github.io/read_structure_step/index.html\n :alt: Documentation Status\n\n.. image:: https://pyup.io/repos/github/molssi-seamm/read_structure_step/shield.svg\n :target: https://pyup.io/repos/github/molssi-seamm/read_structure_step/\n :alt: Updates for Dependencies\n\n.. image:: https://img.shields.io/pypi/v/read_structure_step.svg\n :target: https://pypi.python.org/pypi/read_structure_step\n :alt: PyPi VERSION\n\nA SEAMM plug-in to read common formats in computational chemistry\n\nThe current version uses Open Babel as an engine to parse various\nformats such as PDB, Mol2 or XYZ and transform them into the SEAMM\nstructure format for further use in SEAMM flowcharts.\n\n* Free software: BSD license\n* Documentation: https://molssi-seamm.github.io/read_structure_step/index.html\n* Code: https://github.com/molssi-seamm/read_structure_step\n\nFeatures\n--------\n\n- Emphasis in ease-of-use and simplicity. The public interface\n consists of a single function.\n- Automatic file type recognition.\n- OpenBabel as an engine to parse formats, but other engines can be\n easily implemented.\n- Easily extensible to new formats.\n- Current support for PDB, Mol2 and XYZ files.\n\nExample\n+++++++\n\n.. code:: python\n\n import read_structure_step\n seamm_structure = read_structure_step.read(\"spc.xyz\")\n\nAcknowledgements\n----------------\n\nThis package was created with Cookiecutter_ and the `molssi-seamm/cookiecutter-seamm-plugin`_ project template.\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin\n\nDeveloped by the Molecular Sciences Software Institute (MolSSI_),\nwhich receives funding from the `National Science Foundation`_ under\naward ACI-1547580\n\n.. _MolSSI: https://www.molssi.org\n.. _`National Science Foundation`: https://www.nsf.gov\n\n\n=======\nHistory\n=======\n2024.11.3 -- Bugfix: MOPAC files with references in comments\n * Fixed a bug that caused a crash when reading MOPAC files with references in the\n comments.\n * Updated the MOPAC reader to the new approach for running MOPAC in the cases that\n it is needed: Z-matrices and mixed inputs that OpenBabel can't handle.\n \n2024.8.23 -- Enhancements to directory handling\n * Changed the handling of paths to make them relative to the directory that the step\n is running in. In a loop, for instance, files are relative to the iteration\n directory.\n * When reading files, allow the syntax 'job://<job number>/...' to read files from\n another job. If the job number is omitted, so the prefix is 'job:///...', the top\n directory of the current job is used.\n\n2024.7.28 -- Added new names for systems and configurations\n * Made the naming of systems and configurations consistent with the standard\n parameters for them in the GUI.\n * Removed all \"from file\" options, replacing them with \"title\", which means the title\n from the file, if it exists, or the filename if it doesn't.\n \n2023.11.16 -- Bugfix: titles in SDF files\n * Crashed reading some SDF files write by SEAMM due to the system and configuration\n names encoded in the title having multiple slashes (/).\n\n2023.11.5 -- Added writers for CIF and mmCIF.\n\n2023.11.2 -- Initial changes to structure handling\n * Moving towards the standard structure handling that has developed across SEAMM.\n \n2023.8.30 -- Support for spacegroup symmetry\n\n2023.7.28 -- Implemented ranges for reading XYZ and SDF files.\n\n2023.7.27.1 -- Removed debug printing.\n\n2023.7.27 -- Support for .gz and .bz2 files, and multi-structure .xyz files\n * Handle .gz and .bz2 files for .sdf and .xyz extensions.\n * Handle multi-structure XYZ files with a blank line between records.\n \n2023.7.6 -- Bugfixes\n * Fixed output of number of structures written to SDF files, which was off by 1.\n * Cleaned up the output for the write-structure step\n \n2023.1.30 -- Fixed issue#43, duplicate systems or configuration created\n\n * Reading a single structure from e.g. a .sdf file created a second system or\n configuration, depending on the stucture control options.\n\n2023.1.24 -- Added handler for XYZ files and added properties\n\n * Added a custom handler for XYZ files to cope with some of the variant formats.\n\n * Supports files with no atom count on the first line\n\n * Supports the variant used in the Minnesota Solubility database, which has 3 header\n lines.\n\n * Add capability to store properties into the database for formats such as MOPAC and\n SDF that can handle properties. Also can output the properties when writing the\n files.\n\n * Fixed bugs if the system name or configuration name is not a string, but rather a number.\n\n2022.10.28 -- Fixed bug reading cif and mmcif files\n\n * There was a bug that caused a crash when reading cif and mmcif files, and potentially\n some other formats. It has been fixed throughout.\n\n * The standard error for properties were missing a commma in the property name. The\n comma is standard elsewhere in SEAMM so add it here: '<prop>, stderr'\n\n2022.10.26 -- Handling OpenBabel error messages for MOPAC .mop files\n Hiding messages about errors Kekulizing structures, which doesn't seem to be a serious\n issue, and printing any other messages as warnings.\n\n2021.2.12 (12 February 2021)\n\n * Updated the README file to give a better description.\n\n * Updated the short description in setup.py to work with the new installer.\n\n * Added keywords for better searchability.\n\n2021.2.4 (4 February 2021)\n Updated for compatibility with the new system classes in MolSystem\n 2021.2.2 release.\n\n2020.12.5 (5 December 2020)\n Internal: switching CI from TravisCI to GitHub Actions, and in the\n process moving documentation from ReadTheDocs to GitHub Pages where\n it is consolidated with the main SEAMM documentation.\n\n2020.8.1 (1 August 2020)\n Removed leftover debug print statements.\n\n0.9 (15 April 2020)\n\n * General bug fixing and code cleanup.\n\n * Part of release of all modules.\n\n0.7.1 (23 November 2019)\n First release on PyPI.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "A SEAMM plug-in to read common formats in computational chemistry",
"version": "2024.11.3",
"project_urls": {
"Homepage": "https://github.com/molssi-seamm/read_structure_step"
},
"split_keywords": [
"seamm",
" plug-in",
" flowchart",
" open babel",
" molecules",
" atomistic",
" files"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b006ed99cc4d1f51dbaba37d58aed98cf1fc7570de5dfbbc4e9aad4fe5e67f66",
"md5": "7169ffd235b8c74ee0d6b8e0a6a804a4",
"sha256": "eb69784e9048498bb08b75b2c18dd8049efbb7ab47b7d448b217308ec44a40ea"
},
"downloads": -1,
"filename": "read_structure_step-2024.11.3-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7169ffd235b8c74ee0d6b8e0a6a804a4",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 146740,
"upload_time": "2024-11-03T23:04:11",
"upload_time_iso_8601": "2024-11-03T23:04:11.553565Z",
"url": "https://files.pythonhosted.org/packages/b0/06/ed99cc4d1f51dbaba37d58aed98cf1fc7570de5dfbbc4e9aad4fe5e67f66/read_structure_step-2024.11.3-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ccdc97b4d1f9b382d9ace87657ab730e8c150d01c57039d70acc64d266a56d3",
"md5": "6fe850e93847fa17b76fd059d4e552d3",
"sha256": "71c5cdb5cbdfa7f1c460e254dd55269a821bcfd72ec8c211497d032f543fe31b"
},
"downloads": -1,
"filename": "read_structure_step-2024.11.3.tar.gz",
"has_sig": false,
"md5_digest": "6fe850e93847fa17b76fd059d4e552d3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 934239,
"upload_time": "2024-11-03T23:04:13",
"upload_time_iso_8601": "2024-11-03T23:04:13.784125Z",
"url": "https://files.pythonhosted.org/packages/6c/cd/c97b4d1f9b382d9ace87657ab730e8c150d01c57039d70acc64d266a56d3/read_structure_step-2024.11.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-03 23:04:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "molssi-seamm",
"github_project": "read_structure_step",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "read-structure-step"
}
JSON
