seamm-dashboard-client


Nameseamm-dashboard-client JSON
Version 2024.6.27 PyPI version JSON
download
home_pagehttps://github.com/molssi-seamm/seamm_dashboard_client
SummaryA Python client for the SEAMM Dashboard RESTful API.
upload_time2024-06-26 22:04:36
maintainerNone
docs_urlNone
authorPaul Saxe
requires_pythonNone
licenseBSD-3-Clause
keywords seamm seammdashboard restful client
VCS
bugtrack_url
requirements requests requests-toolbelt
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =========
CMS Plots
=========

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

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

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

.. image:: https://img.shields.io/lgtm/grade/python/g/molssi-seamm/seamm_dashboard_client.svg?logo=lgtm&logoWidth=18
   :target: https://lgtm.com/projects/g/molssi-seamm/seamm_dashboard_client/context:python
   :alt: Code Quality

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

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

Description
-----------

Utilities for creating plots for computational materials/molecular science (CMS)

This package provides tools for creating plotly graphs for e.g. band structure, DOS, and
other specialized plots for CMS applications.

* Free software: LGPL.v3 or later
* Documentation: https://molssi-seamm.github.io/seamm_dashboard_client/index.html

Features
--------

* Density of states (DOS) plots
* Band structure plots
* Combined band structure & DOS plots


Credits
---------

This package was created with Cookiecutter_ and the
`molssi-seamm/cookiecutter-seamm-plugin`_ project template.

Developed by the Molecular Sciences Software Institute (MolSSI_),
which receives funding from the National Science Foundation under
award ACI-1547580

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin
.. _MolSSI: https://molssi.org


=======
History
=======
2024.6.27 -- Added support for using local files in Jobs

2024.5.23 -- Bugfix: crash opening a flowchart from a Dashboard
   * SEAMM could crash when asking the Flowchart Open dialog to get the flowchart from a
     previous job. This only happened if the Dashboard was known but the stored password
     was wrong.

2024.4.22 -- Moving user preferences to ~/.seamm.d
   * Added better output when there are failures in the Dashboard.
   * To better support Docker, moving ~/.seammrc to ~/.seamm.d/seamrc

2023.11.15 -- Bugfix: boolean options now work
   * Boolean options were not handled correctly when submitting jobs.

2023.10.24 -- Improvement for job handling.
   * Added control parameters to the data stored for the job, to support filling out
     menus identical to how the job was submitted.
     
2023.7.29 -- Bugfix: error if no required parameters
   * Apparently can't use '--' without subsequent parameters.
     
2023.7.10 -- Corrected handling of control parameters
   * Now handle control parameters with multiple values.
   * Separate the options from required parameters with '--' as required.
     
2023.6.28 -- Improved error messages for login failures.

2022.8.13 (13 August 2022)
--------------------------

* First release of a working version on PyPI.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/molssi-seamm/seamm_dashboard_client",
    "name": "seamm-dashboard-client",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "SEAMM, SEAMMDashboard, RESTful, client",
    "author": "Paul Saxe",
    "author_email": "psaxe@molssi.org",
    "download_url": "https://files.pythonhosted.org/packages/aa/c1/01e4601d0c5c964236ae025a5b0d66dca976b4855ae35c250c9a2289afdf/seamm_dashboard_client-2024.6.27.tar.gz",
    "platform": "Linux",
    "description": "=========\nCMS Plots\n=========\n\n.. image:: https://img.shields.io/github/issues-pr-raw/molssi-seamm/seamm_dashboard_client\n   :target: https://github.com/molssi-seamm/seamm_dashboard_client/pulls\n   :alt: GitHub pull requests\n\n.. image:: https://github.com/molssi-seamm/seamm_dashboard_client/workflows/CI/badge.svg\n   :target: https://github.com/molssi-seamm/seamm_dashboard_client/actions\n   :alt: Build Status\n\n.. image:: https://codecov.io/gh/molssi-seamm/seamm_dashboard_client/branch/master/graph/badge.svg\n   :target: https://codecov.io/gh/molssi-seamm/seamm_dashboard_client\n   :alt: Code Coverage\n\n.. image:: https://img.shields.io/lgtm/grade/python/g/molssi-seamm/seamm_dashboard_client.svg?logo=lgtm&logoWidth=18\n   :target: https://lgtm.com/projects/g/molssi-seamm/seamm_dashboard_client/context:python\n   :alt: Code Quality\n\n.. image:: https://github.com/molssi-seamm/seamm_dashboard_client/workflows/Documentation/badge.svg\n   :target: https://molssi-seamm.github.io/seamm_dashboard_client/index.html\n   :alt: Documentation Status\n\n.. image:: https://img.shields.io/pypi/v/seamm_dashboard_client.svg\n   :target: https://pypi.python.org/pypi/seamm_dashboard_client\n   :alt: PyPi VERSION\n\nDescription\n-----------\n\nUtilities for creating plots for computational materials/molecular science (CMS)\n\nThis package provides tools for creating plotly graphs for e.g. band structure, DOS, and\nother specialized plots for CMS applications.\n\n* Free software: LGPL.v3 or later\n* Documentation: https://molssi-seamm.github.io/seamm_dashboard_client/index.html\n\nFeatures\n--------\n\n* Density of states (DOS) plots\n* Band structure plots\n* Combined band structure & DOS plots\n\n\nCredits\n---------\n\nThis package was created with Cookiecutter_ and the\n`molssi-seamm/cookiecutter-seamm-plugin`_ project template.\n\nDeveloped by the Molecular Sciences Software Institute (MolSSI_),\nwhich receives funding from the National Science Foundation under\naward ACI-1547580\n\n.. _Cookiecutter: https://github.com/audreyr/cookiecutter\n.. _`molssi-seamm/cookiecutter-seamm-plugin`: https://github.com/molssi-seamm/cookiecutter-seamm-plugin\n.. _MolSSI: https://molssi.org\n\n\n=======\nHistory\n=======\n2024.6.27 -- Added support for using local files in Jobs\n\n2024.5.23 -- Bugfix: crash opening a flowchart from a Dashboard\n   * SEAMM could crash when asking the Flowchart Open dialog to get the flowchart from a\n     previous job. This only happened if the Dashboard was known but the stored password\n     was wrong.\n\n2024.4.22 -- Moving user preferences to ~/.seamm.d\n   * Added better output when there are failures in the Dashboard.\n   * To better support Docker, moving ~/.seammrc to ~/.seamm.d/seamrc\n\n2023.11.15 -- Bugfix: boolean options now work\n   * Boolean options were not handled correctly when submitting jobs.\n\n2023.10.24 -- Improvement for job handling.\n   * Added control parameters to the data stored for the job, to support filling out\n     menus identical to how the job was submitted.\n     \n2023.7.29 -- Bugfix: error if no required parameters\n   * Apparently can't use '--' without subsequent parameters.\n     \n2023.7.10 -- Corrected handling of control parameters\n   * Now handle control parameters with multiple values.\n   * Separate the options from required parameters with '--' as required.\n     \n2023.6.28 -- Improved error messages for login failures.\n\n2022.8.13 (13 August 2022)\n--------------------------\n\n* First release of a working version on PyPI.\n",
    "bugtrack_url": null,
    "license": "BSD-3-Clause",
    "summary": "A Python client for the SEAMM Dashboard RESTful API.",
    "version": "2024.6.27",
    "project_urls": {
        "Homepage": "https://github.com/molssi-seamm/seamm_dashboard_client"
    },
    "split_keywords": [
        "seamm",
        " seammdashboard",
        " restful",
        " client"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d02619a513ad6624dbf9dff8f57f74cdb359f38a0114594ad2319405a3aa5baf",
                "md5": "7911c6e0a809290ba074a544b9766ba5",
                "sha256": "a5c607777a4e0063d01f06d3f9805a57d545717de49a02ad79879dd086563f66"
            },
            "downloads": -1,
            "filename": "seamm_dashboard_client-2024.6.27-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7911c6e0a809290ba074a544b9766ba5",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 11309,
            "upload_time": "2024-06-26T22:04:35",
            "upload_time_iso_8601": "2024-06-26T22:04:35.177223Z",
            "url": "https://files.pythonhosted.org/packages/d0/26/19a513ad6624dbf9dff8f57f74cdb359f38a0114594ad2319405a3aa5baf/seamm_dashboard_client-2024.6.27-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aac101e4601d0c5c964236ae025a5b0d66dca976b4855ae35c250c9a2289afdf",
                "md5": "30ca432b2f470e68d282b2d950988214",
                "sha256": "a42edee800781fd5f5a7f5c84067de039688e39676b173255306395000f24c6d"
            },
            "downloads": -1,
            "filename": "seamm_dashboard_client-2024.6.27.tar.gz",
            "has_sig": false,
            "md5_digest": "30ca432b2f470e68d282b2d950988214",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 41565,
            "upload_time": "2024-06-26T22:04:36",
            "upload_time_iso_8601": "2024-06-26T22:04:36.981657Z",
            "url": "https://files.pythonhosted.org/packages/aa/c1/01e4601d0c5c964236ae025a5b0d66dca976b4855ae35c250c9a2289afdf/seamm_dashboard_client-2024.6.27.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-06-26 22:04:36",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "molssi-seamm",
    "github_project": "seamm_dashboard_client",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "requirements": [
        {
            "name": "requests",
            "specs": []
        },
        {
            "name": "requests-toolbelt",
            "specs": []
        }
    ],
    "lcname": "seamm-dashboard-client"
}
        
Elapsed time: 3.72985s