surfsci


Namesurfsci JSON
Version 0.2.0 PyPI version JSON
download
home_pageNone
SummaryA suite of tools for handling surface science related x-ray data
upload_time2025-09-09 22:26:45
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords surface science
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # surfsci

`surfsci` is a set of scripts for handling and maniplulating surface science x-ray data.

[![PyPI - Version](https://img.shields.io/pypi/v/surfsci.svg)](https://pypi.org/project/surfsci)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/surfsci.svg)](https://pypi.org/project/surfsci)

-----

## Table of Contents

- [Installation](#installation)
- [X-ray](#x-ray)
- [License](#license)

## Installation

```console
pip install surfsci
```

## X-ray Photoelectron Spectroscopy

This is just a convenience wrapper around [xps](https://pypi.org/project/xps/)

```python
from surfsci import xps
```

## X-ray

### X-ray Diffratometer 500 / 5000

Conversion script for _asc_ to _xy_ format. Handy if you want easily parsable data or want to use [fityk](https://fityk.nieto.pl/).

```sh
surfsci-xy-conv my_xrd_data.asc
```

This will generate _my_xrd_data.xy_

### MAX3D G-Pol 2D X-ray data

Plot and x-y data for the _*.gpol_ files produced by the [MAX3D detector at McMaster](https://max3d.mcmaster.ca/doc/index.html). Usage,

```sh
surfsci-gpol my_data_file.gpol
```

## License

`surfsci` is distributed under the terms of the [BSD-2-Clause](https://spdx.org/licenses/BSD-2-Clause.html) license.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "surfsci",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "Surface Science",
    "author": null,
    "author_email": "David Kalliecharan <david@david.science>",
    "download_url": "https://files.pythonhosted.org/packages/bd/76/006434fa19f31f85488ad072e84f56f225cdc5b072135a37b974d34bfddb/surfsci-0.2.0.tar.gz",
    "platform": null,
    "description": "# surfsci\n\n`surfsci` is a set of scripts for handling and maniplulating surface science x-ray data.\n\n[![PyPI - Version](https://img.shields.io/pypi/v/surfsci.svg)](https://pypi.org/project/surfsci)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/surfsci.svg)](https://pypi.org/project/surfsci)\n\n-----\n\n## Table of Contents\n\n- [Installation](#installation)\n- [X-ray](#x-ray)\n- [License](#license)\n\n## Installation\n\n```console\npip install surfsci\n```\n\n## X-ray Photoelectron Spectroscopy\n\nThis is just a convenience wrapper around [xps](https://pypi.org/project/xps/)\n\n```python\nfrom surfsci import xps\n```\n\n## X-ray\n\n### X-ray Diffratometer 500 / 5000\n\nConversion script for _asc_ to _xy_ format. Handy if you want easily parsable data or want to use [fityk](https://fityk.nieto.pl/).\n\n```sh\nsurfsci-xy-conv my_xrd_data.asc\n```\n\nThis will generate _my_xrd_data.xy_\n\n### MAX3D G-Pol 2D X-ray data\n\nPlot and x-y data for the _*.gpol_ files produced by the [MAX3D detector at McMaster](https://max3d.mcmaster.ca/doc/index.html). Usage,\n\n```sh\nsurfsci-gpol my_data_file.gpol\n```\n\n## License\n\n`surfsci` is distributed under the terms of the [BSD-2-Clause](https://spdx.org/licenses/BSD-2-Clause.html) license.\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A suite of tools for handling surface science related x-ray data",
    "version": "0.2.0",
    "project_urls": {
        "Documentation": "https://gitlab.com/ddkn/surfsci#readme",
        "Issues": "https://gitlab.com/ddkn/surfsci/issues",
        "Source": "https://gitlab.com/ddkn/surfsci"
    },
    "split_keywords": [
        "surface",
        "science"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "521be04e04c9ccc51117f85c64860cc01e2d469aa19c57a0839e884f10ef127f",
                "md5": "43e19d435ead45180b0f0664f884e547",
                "sha256": "a16ffd8c9df42d59a718a20785cf4a6d23d0eea7121f8f258a0e02cbdac2bc9b"
            },
            "downloads": -1,
            "filename": "surfsci-0.2.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "43e19d435ead45180b0f0664f884e547",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 8993,
            "upload_time": "2025-09-09T22:26:44",
            "upload_time_iso_8601": "2025-09-09T22:26:44.561822Z",
            "url": "https://files.pythonhosted.org/packages/52/1b/e04e04c9ccc51117f85c64860cc01e2d469aa19c57a0839e884f10ef127f/surfsci-0.2.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "bd76006434fa19f31f85488ad072e84f56f225cdc5b072135a37b974d34bfddb",
                "md5": "a700c35a31ce139b55b5ed137b93a4bf",
                "sha256": "9fedabe2abe00b57e7abfff6742bfeb719aa0cae94e4ba8739e0be92486c021e"
            },
            "downloads": -1,
            "filename": "surfsci-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "a700c35a31ce139b55b5ed137b93a4bf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 6051,
            "upload_time": "2025-09-09T22:26:45",
            "upload_time_iso_8601": "2025-09-09T22:26:45.872121Z",
            "url": "https://files.pythonhosted.org/packages/bd/76/006434fa19f31f85488ad072e84f56f225cdc5b072135a37b974d34bfddb/surfsci-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-09-09 22:26:45",
    "github": false,
    "gitlab": true,
    "bitbucket": false,
    "codeberg": false,
    "gitlab_user": "ddkn",
    "gitlab_project": "surfsci#readme",
    "lcname": "surfsci"
}
        
Elapsed time: 1.56856s