ewokspdf


Nameewokspdf JSON
Version 0.1.2 PyPI version JSON
download
home_pageNone
SummaryEwoks project for processing Pair Distribution Function analysis (PDF).
upload_time2025-01-29 10:52:14
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
license# MIT License **Copyright (c) 2024 European Synchrotron Radiation Facility** Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords orange3 add-on ewoks
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # ewokspdf

The **ewokspdf Project** is a Python library designed to provide Pair Distribution Function (PDF) analysis ewoks workflow tasks. 
The library is based on the calculations of [PDFgetX3](https://www.diffpy.org/products/pdfgetx.html) python API. The main tasks are: pattern averaging, `pdfgetx` configuration, `pdfgetx` processing and saving in box HDF5 and ASCII files.

## Installation

By default, at the ESRF, `ewokspdf` should be installed on `ewoks` workers with an Ansible script by the DAU team.

If you wish to install `ewokspdf` by yourself, you’ll need Python 3.7+ and `pip`. You can install the library directly from PyPI:

```bash
pip install ewokspdf
```

Alternatively, to install from source, clone this repository and run:

```bash
git clone https://gitlab.esrf.fr/workflow/ewoksapps/ewokspdf.git
cd ewokspdf
pip install -e .
```
`ewokspdf` has only two requirements: `ewoksxrpd` and `diffpy.pdfgetx`. `diffpy.pdgetx` can be downloaded [here](https://www.diffpy.org/products/pdfgetx.html). To install it you can run:

```bash
pip install ./diffpy.pdfgetx-VERSION.whl
```

## Quickstart Guide

### Running an ewokspdf workflow


## How-To Guides

For detailed instructions on various tasks, please refer to the [How-To Guides section](./docs/how_to_guides.md) in the 
documentation, which covers topics like:

- Configuration of the workflow
- Running the workflow locally
- Using the API to run specific tasks

## Documentation

Comprehensive documentation, including an API reference, tutorials, and conceptual explanations, can be found in the 
[docs directory](./doc) or online at the [ReadTheDocs page](https://ewokspdf.readthedocs.io).

## Contributing

Contributions are welcome! To contribute, please:

1. Clone the repository and create a new branch for your feature or fix.
2. Write tests and ensure that the code is well-documented.
3. Submit a merge request for review.

See the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more details.

## License

This project is licensed under the MIT License. See the [LICENSE.md](./LICENSE.md) file for details.

## Support

If you have any questions or issues, please open an issue on the Gitlab repository or contact us wiht a [data processing request ticket](https://requests.esrf.fr/plugins/servlet/desk/portal/41).

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "ewokspdf",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "orange3 add-on, ewoks",
    "author": null,
    "author_email": "ESRF <dau-pydev@esrf.fr>",
    "download_url": "https://files.pythonhosted.org/packages/59/6f/11f06d77ecf54901e6c981806e8202d6c8ee893f3a9d241999b1bfb8d75c/ewokspdf-0.1.2.tar.gz",
    "platform": null,
    "description": "# ewokspdf\n\nThe **ewokspdf Project** is a Python library designed to provide Pair Distribution Function (PDF) analysis ewoks workflow tasks. \nThe library is based on the calculations of [PDFgetX3](https://www.diffpy.org/products/pdfgetx.html) python API. The main tasks are: pattern averaging, `pdfgetx` configuration, `pdfgetx` processing and saving in box HDF5 and ASCII files.\n\n## Installation\n\nBy default, at the ESRF, `ewokspdf` should be installed on `ewoks` workers with an Ansible script by the DAU team.\n\nIf you wish to install `ewokspdf` by yourself, you\u2019ll need Python 3.7+ and `pip`. You can install the library directly from PyPI:\n\n```bash\npip install ewokspdf\n```\n\nAlternatively, to install from source, clone this repository and run:\n\n```bash\ngit clone https://gitlab.esrf.fr/workflow/ewoksapps/ewokspdf.git\ncd ewokspdf\npip install -e .\n```\n`ewokspdf` has only two requirements: `ewoksxrpd` and `diffpy.pdfgetx`. `diffpy.pdgetx` can be downloaded [here](https://www.diffpy.org/products/pdfgetx.html). To install it you can run:\n\n```bash\npip install ./diffpy.pdfgetx-VERSION.whl\n```\n\n## Quickstart Guide\n\n### Running an ewokspdf workflow\n\n\n## How-To Guides\n\nFor detailed instructions on various tasks, please refer to the [How-To Guides section](./docs/how_to_guides.md) in the \ndocumentation, which covers topics like:\n\n- Configuration of the workflow\n- Running the workflow locally\n- Using the API to run specific tasks\n\n## Documentation\n\nComprehensive documentation, including an API reference, tutorials, and conceptual explanations, can be found in the \n[docs directory](./doc) or online at the [ReadTheDocs page](https://ewokspdf.readthedocs.io).\n\n## Contributing\n\nContributions are welcome! To contribute, please:\n\n1. Clone the repository and create a new branch for your feature or fix.\n2. Write tests and ensure that the code is well-documented.\n3. Submit a merge request for review.\n\nSee the [CONTRIBUTING.md](./CONTRIBUTING.md) file for more details.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE.md](./LICENSE.md) file for details.\n\n## Support\n\nIf you have any questions or issues, please open an issue on the Gitlab repository or contact us wiht a [data processing request ticket](https://requests.esrf.fr/plugins/servlet/desk/portal/41).\n",
    "bugtrack_url": null,
    "license": "# MIT License\n        \n        **Copyright (c) 2024 European Synchrotron Radiation Facility**\n        \n        Permission is hereby granted, free of charge, to any person obtaining a copy of\n        this software and associated documentation files (the \"Software\"), to deal in\n        the Software without restriction, including without limitation the rights to\n        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of\n        the Software, and to permit persons to whom the Software is furnished to do so,\n        subject to the following conditions:\n        \n        The above copyright notice and this permission notice shall be included in all\n        copies or substantial portions of the Software.\n        \n        THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS\n        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR\n        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER\n        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN\n        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n        ",
    "summary": "Ewoks project for processing Pair Distribution Function analysis (PDF).",
    "version": "0.1.2",
    "project_urls": {
        "Changelog": "https://gitlab.esrf.fr/workflow/ewoksapps/ewokspdf/-/blob/main/CHANGELOG.md",
        "Documentation": "https://ewokspdf.readthedocs.io/",
        "Homepage": "https://gitlab.esrf.fr/workflow/ewoksapps/ewokspdf/",
        "Issues": "https://gitlab.esrf.fr/workflow/ewoksapps/ewokspdf/issues",
        "Repository": "https://gitlab.esrf.fr/workflow/ewoksapps/ewokspdf/"
    },
    "split_keywords": [
        "orange3 add-on",
        " ewoks"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "596f11f06d77ecf54901e6c981806e8202d6c8ee893f3a9d241999b1bfb8d75c",
                "md5": "32524849b4799e270f4d85eb3eb97e28",
                "sha256": "3300644eff8d05449e98972a5173eb435d222639c7715f2e1b2745a5dd654e10"
            },
            "downloads": -1,
            "filename": "ewokspdf-0.1.2.tar.gz",
            "has_sig": false,
            "md5_digest": "32524849b4799e270f4d85eb3eb97e28",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 1417303,
            "upload_time": "2025-01-29T10:52:14",
            "upload_time_iso_8601": "2025-01-29T10:52:14.741208Z",
            "url": "https://files.pythonhosted.org/packages/59/6f/11f06d77ecf54901e6c981806e8202d6c8ee893f3a9d241999b1bfb8d75c/ewokspdf-0.1.2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-01-29 10:52:14",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "ewokspdf"
}
None
Elapsed time: 0.53677s