seamm


Nameseamm JSON
Version 2024.5.3.1 PyPI version JSON
download
home_pagehttps://github.com/molssi-seamm/seamm
SummaryThe core of the SEAMM environment and graphical interface.
upload_time2024-05-03 20:49:58
maintainerNone
docs_urlNone
authorPaul Saxe
requires_pythonNone
licenseGNU Lesser General Public License v3
keywords seamm
VCS
bugtrack_url
requirements bibtexparser fasteners humanize jinja2 molsystem numpy packaging pandas pillow pmw py-cpuinfo python-dateutil pyuca reference_handler seamm-dashboard-client seamm-datastore seamm-util seamm-widgets stevedore
Travis-CI No Travis.
coveralls test coverage
            ======================================================================
Simulation Environment for Atomistic and Molecular Simulations (SEAMM)
======================================================================

.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/seamm
   :target: https://github.com/molssi-seamm/seamm/pulls
   :alt: GitHub pull requests

.. image:: https://github.com/molssi-seamm/seamm/workflows/CI/badge.svg
   :target: https://github.com/molssi-seamm/seamm/actions
   :alt: Build Status

.. image:: https://codecov.io/gh/molssi-seamm/seamm/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/molssi-seamm/seamm
   :alt: Code Coverage

.. image:: https://github.com/molssi-seamm/seamm/workflows/CodeQL/badge.svg
   :target: https://github.com/molssi-seamm/seamm/security/code-scanning
   :alt: Code Quality

.. image:: https://github.com/molssi-seamm/seamm/workflows/Release/badge.svg
   :target: https://molssi-seamm.github.io/seamm/index.html
   :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/seamm.svg
   :target: https://pypi.python.org/pypi/seamm
   :alt: PyPi VERSION

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5153984.svg
   :target: https://doi.org/10.5281/zenodo.5153984
   :alt: DOI

The MolSSI Simulation Environment for computational molecular and materials science (CMS)


* Free software: GNU Lesser General Public License v3
* Documentation: https://molssi-seamm.github.io/seamm/index.html


Features
--------

* TODO

Credits
-------

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
awards OAC-1547580 and CHE-2136142

.. _MolSSI: https://www.molssi.org
.. _`National Science Foundation`: https://www.nsf.gov


=======
History
=======
2024.5.3.1 -- Bugfix: JSON in Results GUI not set correctly.

2024.5.3 -- Added the time to Results.json
    * Adding time into the Results.json file will allow ensuring that the most
      recent data is used, when there are duplicates.
      
2024.5.1 -- Added ability to store results in Results.json file
    * Added column in the results tab for saving results to JSON
    * Added separators between the columns of the results table to make clearer which
      parameters go together.
      
2024.4.22 -- Moving user preferences to ~/.seamm.d
    * To better support Docker, moving ~/.seammrc to ~/.seamm.d/seamrc

2024.1.2 -- Corrected issue with citations in development versions
    * Fixed an issue getting the date of a plug-in for development versions of the
      plug-in. This did not affect end users, but did cause issues for development.
      
2023.12.18 -- Moving execution of flowcharts to seamm-exec
    * Moved execution of flowcharts to seamm-exec to consolidate execution in one
      place. This will allow easier, faster developement for running in queues, etc.
    * Switched the dependency on PMW from CondaForge to PIP since the version on
      CondaForge is poorly maintained.
      
2023.12.12 -- Moving ~/.seammrc to ~/.seamm.d/seammrc
    * Should have no effect on users. The seammrc file will be moved automatically to
      its new location. This change is necessary to be able to run SEAMM in containers.
      
2023.11.15 -- Add boolean options when submitting jobs
    * Added boolean control parameters when submitting jobs.
    * Bugfix: The previous change to allow running "flowchart.flow" in the current
      directory caused a bug in other scenarios.
      
2023.11.12 -- Allowing running flowchart.flow in current directory
    * There was a feature which prevented running a flowchart named "flowchart.flow" in
      the current directory when running from the commandline.
      
2023.11.11 -- Incorporating changes to Zenodo
    * Zenodo updated and made small changes to their API, which required changes in
      SEAMM.
    * Consolidated all private information about the user and their keys for Zenodo in
      ~/.seammrc
      
2023.11.7 -- Bugfix: initialization of Dashboard
    * Fixed a crash that occurred the very first time submitting to the Dashboard.

2023.10.30 -- Extending and cleaning up handling of configurations
    * Added ability to name systems and configurations with the IUPAC name, InChI, or
      InChIKey of the configuration.
    * Generally cleanedup and streamlined the code handling new systems and
      configurations.

2023.9.26.1 -- Bugfix: system naming
    * Fixed a bug with keeping the current name when updating a system.
      
2023.9.26 -- Added units to header in tables, and bugfixes.
    * The headers for table columns now include units when generated automatically when
      writing results. Existing columns are not changed.
    * Changed the join step image and added the code to enable deleting it.
    * Fixed an issue with the sizie of subwindows in edit dialogs
      
2023.8.30 -- Added support for keyed columns in table output
    * Caught errors when writing out the final structures for viewing and improved
      messages in such cases.
    * Keyed columns in table output are used for e.g. the diffusion coefficients of
      multi-component fluids, where the column is expanded for each component.
      
2023.7.10 -- Adding JSON for properties in the database and tabels; bugfixes
    * Handle non-scalar results using JSON so they can be output to tables
      and added to the properties in the database.
    * Fixed error submitting jobs to Dashboard the user doesn't have a login for.
    * Ask for credentials when adding a new dashboard to job dialog.
    * Fixed bug creating a new project.

2023.6.28 -- Improved error handling contacting Dashboards.
    * Trap and display errors when contacting Dashboards
    * Allow SEAMM to continue despite such errors
      
2023.5.29 -- Fixed bug with missing directories when executing codes

2023.4.24 -- Enhancements for thermal conductivity
    * Enhanced handling of command-line options to supported self contained flowcharts.
    * Various enhancements to graphs to better present results.
    * Added tracebacks to error report to identify the code responsible for the issue.
    * Correctly remember the filename for flowcharts opened from disk.

2023.4.6 -- Bugfix: issue running standalone
    * When a description was not provided in either the command-line or the flowchart,
      running standlone crashed.
      
2023.3.31 -- Bugfix: formatting of dates
    * Fixed a minor issue with formatting the dates in Job.out.
      
2023.3.23 -- Updates for new JobServer
    * Jobs running from the JobServer now update their status in the datastore as they
      finish. This helps support jobs continuing if the JobServer crashes or stops.

2023.3.8 -- Fixed bug running from command-line (Incorrectly labeled 2023.4.8!)
    * Fixed bug running from the command-line when giving project so the job is put in
      the datastore.
    * Improved handling of title and description both when running from the
      command-line and GUI, defaulting to the title and description of the flowchart. 

2023.2.15 --
    * Improved handling of structures
    * Added ability to run simulations engine in a given directory, typically the step
      directory. This allows users to see the outputs during the simulation rather than
      having to wait until the end.
    * Added support allowing a flowchart to be run as a sub-flowchart.
      
2022.10.23 -- Simplified plug-ins
    Better support for plug-ins and the SEAMM cookiecutter:

       * Automated most handling of results and properties, based on metadata
       * Simplified handling of sub-flowcharts.

2022.10.20 -- Properties in database
    Added support for handling properties the database.

2022.9.13 -- Bugfix: reading MOPAC .mop files
    Fixed a bug that impacted read-structure-step finding MOPAC to use as a
    helper when reading .mop files.

2022.9.8 -- Remembering location of flowcharts
    Added memory of where you were last opening flowcharts, and directories that you
    use, to make it a bit easier.
    
2022.7.25 -- DOS and Band Structure graphs
    Adding support for combined bandstructure/DOS graphs.

2022.6.9 -- Addeded --version option
    * Added a --version argument to print version and stop. by @paulsaxe in #130
    * Switched to reusable GitHub workflows (internal development improvement).

0.1.0 (2018-01-20) -- Initial Release!
    First release on PyPI.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/molssi-seamm/seamm",
    "name": "seamm",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "seamm",
    "author": "Paul Saxe",
    "author_email": "psaxe@molssi.org",
    "download_url": "https://files.pythonhosted.org/packages/5c/3a/3ff97f8f1ee053a7340cdad16894854c31f75ad74b5d38b7b139fe62e75a/seamm-2024.5.3.1.tar.gz",
    "platform": "Linux",
    "description": "======================================================================\nSimulation Environment for Atomistic and Molecular Simulations (SEAMM)\n======================================================================\n\n.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/seamm\n   :target: https://github.com/molssi-seamm/seamm/pulls\n   :alt: GitHub pull requests\n\n.. image:: https://github.com/molssi-seamm/seamm/workflows/CI/badge.svg\n   :target: https://github.com/molssi-seamm/seamm/actions\n   :alt: Build Status\n\n.. image:: https://codecov.io/gh/molssi-seamm/seamm/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/molssi-seamm/seamm\n   :alt: Code Coverage\n\n.. image:: https://github.com/molssi-seamm/seamm/workflows/CodeQL/badge.svg\n   :target: https://github.com/molssi-seamm/seamm/security/code-scanning\n   :alt: Code Quality\n\n.. image:: https://github.com/molssi-seamm/seamm/workflows/Release/badge.svg\n   :target: https://molssi-seamm.github.io/seamm/index.html\n   :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/v/seamm.svg\n   :target: https://pypi.python.org/pypi/seamm\n   :alt: PyPi VERSION\n\n.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.5153984.svg\n   :target: https://doi.org/10.5281/zenodo.5153984\n   :alt: DOI\n\nThe MolSSI Simulation Environment for computational molecular and materials science (CMS)\n\n\n* Free software: GNU Lesser General Public License v3\n* Documentation: https://molssi-seamm.github.io/seamm/index.html\n\n\nFeatures\n--------\n\n* TODO\n\nCredits\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\nawards OAC-1547580 and CHE-2136142\n\n.. _MolSSI: https://www.molssi.org\n.. _`National Science Foundation`: https://www.nsf.gov\n\n\n=======\nHistory\n=======\n2024.5.3.1 -- Bugfix: JSON in Results GUI not set correctly.\n\n2024.5.3 -- Added the time to Results.json\n    * Adding time into the Results.json file will allow ensuring that the most\n      recent data is used, when there are duplicates.\n      \n2024.5.1 -- Added ability to store results in Results.json file\n    * Added column in the results tab for saving results to JSON\n    * Added separators between the columns of the results table to make clearer which\n      parameters go together.\n      \n2024.4.22 -- Moving user preferences to ~/.seamm.d\n    * To better support Docker, moving ~/.seammrc to ~/.seamm.d/seamrc\n\n2024.1.2 -- Corrected issue with citations in development versions\n    * Fixed an issue getting the date of a plug-in for development versions of the\n      plug-in. This did not affect end users, but did cause issues for development.\n      \n2023.12.18 -- Moving execution of flowcharts to seamm-exec\n    * Moved execution of flowcharts to seamm-exec to consolidate execution in one\n      place. This will allow easier, faster developement for running in queues, etc.\n    * Switched the dependency on PMW from CondaForge to PIP since the version on\n      CondaForge is poorly maintained.\n      \n2023.12.12 -- Moving ~/.seammrc to ~/.seamm.d/seammrc\n    * Should have no effect on users. The seammrc file will be moved automatically to\n      its new location. This change is necessary to be able to run SEAMM in containers.\n      \n2023.11.15 -- Add boolean options when submitting jobs\n    * Added boolean control parameters when submitting jobs.\n    * Bugfix: The previous change to allow running \"flowchart.flow\" in the current\n      directory caused a bug in other scenarios.\n      \n2023.11.12 -- Allowing running flowchart.flow in current directory\n    * There was a feature which prevented running a flowchart named \"flowchart.flow\" in\n      the current directory when running from the commandline.\n      \n2023.11.11 -- Incorporating changes to Zenodo\n    * Zenodo updated and made small changes to their API, which required changes in\n      SEAMM.\n    * Consolidated all private information about the user and their keys for Zenodo in\n      ~/.seammrc\n      \n2023.11.7 -- Bugfix: initialization of Dashboard\n    * Fixed a crash that occurred the very first time submitting to the Dashboard.\n\n2023.10.30 -- Extending and cleaning up handling of configurations\n    * Added ability to name systems and configurations with the IUPAC name, InChI, or\n      InChIKey of the configuration.\n    * Generally cleanedup and streamlined the code handling new systems and\n      configurations.\n\n2023.9.26.1 -- Bugfix: system naming\n    * Fixed a bug with keeping the current name when updating a system.\n      \n2023.9.26 -- Added units to header in tables, and bugfixes.\n    * The headers for table columns now include units when generated automatically when\n      writing results. Existing columns are not changed.\n    * Changed the join step image and added the code to enable deleting it.\n    * Fixed an issue with the sizie of subwindows in edit dialogs\n      \n2023.8.30 -- Added support for keyed columns in table output\n    * Caught errors when writing out the final structures for viewing and improved\n      messages in such cases.\n    * Keyed columns in table output are used for e.g. the diffusion coefficients of\n      multi-component fluids, where the column is expanded for each component.\n      \n2023.7.10 -- Adding JSON for properties in the database and tabels; bugfixes\n    * Handle non-scalar results using JSON so they can be output to tables\n      and added to the properties in the database.\n    * Fixed error submitting jobs to Dashboard the user doesn't have a login for.\n    * Ask for credentials when adding a new dashboard to job dialog.\n    * Fixed bug creating a new project.\n\n2023.6.28 -- Improved error handling contacting Dashboards.\n    * Trap and display errors when contacting Dashboards\n    * Allow SEAMM to continue despite such errors\n      \n2023.5.29 -- Fixed bug with missing directories when executing codes\n\n2023.4.24 -- Enhancements for thermal conductivity\n    * Enhanced handling of command-line options to supported self contained flowcharts.\n    * Various enhancements to graphs to better present results.\n    * Added tracebacks to error report to identify the code responsible for the issue.\n    * Correctly remember the filename for flowcharts opened from disk.\n\n2023.4.6 -- Bugfix: issue running standalone\n    * When a description was not provided in either the command-line or the flowchart,\n      running standlone crashed.\n      \n2023.3.31 -- Bugfix: formatting of dates\n    * Fixed a minor issue with formatting the dates in Job.out.\n      \n2023.3.23 -- Updates for new JobServer\n    * Jobs running from the JobServer now update their status in the datastore as they\n      finish. This helps support jobs continuing if the JobServer crashes or stops.\n\n2023.3.8 -- Fixed bug running from command-line (Incorrectly labeled 2023.4.8!)\n    * Fixed bug running from the command-line when giving project so the job is put in\n      the datastore.\n    * Improved handling of title and description both when running from the\n      command-line and GUI, defaulting to the title and description of the flowchart. \n\n2023.2.15 --\n    * Improved handling of structures\n    * Added ability to run simulations engine in a given directory, typically the step\n      directory. This allows users to see the outputs during the simulation rather than\n      having to wait until the end.\n    * Added support allowing a flowchart to be run as a sub-flowchart.\n      \n2022.10.23 -- Simplified plug-ins\n    Better support for plug-ins and the SEAMM cookiecutter:\n\n       * Automated most handling of results and properties, based on metadata\n       * Simplified handling of sub-flowcharts.\n\n2022.10.20 -- Properties in database\n    Added support for handling properties the database.\n\n2022.9.13 -- Bugfix: reading MOPAC .mop files\n    Fixed a bug that impacted read-structure-step finding MOPAC to use as a\n    helper when reading .mop files.\n\n2022.9.8 -- Remembering location of flowcharts\n    Added memory of where you were last opening flowcharts, and directories that you\n    use, to make it a bit easier.\n    \n2022.7.25 -- DOS and Band Structure graphs\n    Adding support for combined bandstructure/DOS graphs.\n\n2022.6.9 -- Addeded --version option\n    * Added a --version argument to print version and stop. by @paulsaxe in #130\n    * Switched to reusable GitHub workflows (internal development improvement).\n\n0.1.0 (2018-01-20) -- Initial Release!\n    First release on PyPI.\n",
    "bugtrack_url": null,
    "license": "GNU Lesser General Public License v3",
    "summary": "The core of the SEAMM environment and graphical interface.",
    "version": "2024.5.3.1",
    "project_urls": {
        "Homepage": "https://github.com/molssi-seamm/seamm"
    },
    "split_keywords": [
        "seamm"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "07a16d0c1e7638628a7606a940b52607090e184c31ae3fa6137129975ec6a5fd",
                "md5": "144855e19b3f123fa84ab5fbf8331d7e",
                "sha256": "37cf472ba2298984b08ff178dd34ceca7bc638864995d5d994cee9c0bfe30626"
            },
            "downloads": -1,
            "filename": "seamm-2024.5.3.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "144855e19b3f123fa84ab5fbf8331d7e",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 226272,
            "upload_time": "2024-05-03T20:49:56",
            "upload_time_iso_8601": "2024-05-03T20:49:56.348444Z",
            "url": "https://files.pythonhosted.org/packages/07/a1/6d0c1e7638628a7606a940b52607090e184c31ae3fa6137129975ec6a5fd/seamm-2024.5.3.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5c3a3ff97f8f1ee053a7340cdad16894854c31f75ad74b5d38b7b139fe62e75a",
                "md5": "58e04af5eb5cf45a9584c14bc38ed3ca",
                "sha256": "c46bebebbaa545dfa00e3872a0ec2c1989d1d1823982900dd3b5ff75b2a0a5b1"
            },
            "downloads": -1,
            "filename": "seamm-2024.5.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "58e04af5eb5cf45a9584c14bc38ed3ca",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 505548,
            "upload_time": "2024-05-03T20:49:58",
            "upload_time_iso_8601": "2024-05-03T20:49:58.856074Z",
            "url": "https://files.pythonhosted.org/packages/5c/3a/3ff97f8f1ee053a7340cdad16894854c31f75ad74b5d38b7b139fe62e75a/seamm-2024.5.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-05-03 20:49:58",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "molssi-seamm",
    "github_project": "seamm",
    "travis_ci": false,
    "coveralls": true,
    "github_actions": true,
    "requirements": [
        {
            "name": "bibtexparser",
            "specs": []
        },
        {
            "name": "fasteners",
            "specs": []
        },
        {
            "name": "humanize",
            "specs": []
        },
        {
            "name": "jinja2",
            "specs": []
        },
        {
            "name": "molsystem",
            "specs": []
        },
        {
            "name": "numpy",
            "specs": []
        },
        {
            "name": "packaging",
            "specs": []
        },
        {
            "name": "pandas",
            "specs": []
        },
        {
            "name": "pillow",
            "specs": []
        },
        {
            "name": "pmw",
            "specs": []
        },
        {
            "name": "py-cpuinfo",
            "specs": []
        },
        {
            "name": "python-dateutil",
            "specs": []
        },
        {
            "name": "pyuca",
            "specs": []
        },
        {
            "name": "reference_handler",
            "specs": []
        },
        {
            "name": "seamm-dashboard-client",
            "specs": []
        },
        {
            "name": "seamm-datastore",
            "specs": []
        },
        {
            "name": "seamm-util",
            "specs": []
        },
        {
            "name": "seamm-widgets",
            "specs": []
        },
        {
            "name": "stevedore",
            "specs": []
        }
    ],
    "tox": true,
    "lcname": "seamm"
}
        
Elapsed time: 0.27957s