python-grace


Namepython-grace JSON
Version 0.0.9 PyPI version JSON
download
home_pagehttps://github.com/tueda/python-grace
SummaryAn unofficial Python wrapper for the GRACE system.
upload_time2023-08-15 06:14:43
maintainer
docs_urlNone
authorTakahiro Ueda
requires_python>=3.6.1,<4.0.0
licenseMIT
keywords particle physics automatic calculation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            python-grace
============

[![Test](https://github.com/tueda/python-grace/workflows/Test/badge.svg?branch=main)](https://github.com/tueda/python-grace/actions?query=branch:main)
[![PyPI version](https://badge.fury.io/py/python-grace.svg)](https://pypi.org/project/python-grace/)

An unofficial Python wrapper for [the GRACE system](https://minami-home.kek.jp/)
(the public version for tree-level computations).

*This is a pre-alpha version.*


Requirements
------------

- Python >= 3.6.1
- pip >= 19.0
- C compiler
- Fortran compiler
- Make utility
- X Window system (optional, for `gracefig` and `grcdraw`)
- Motif Toolkit or its clone (optional, for `gracefig`)
- `ps2pdf` in Ghostscript (optional, to generate PDF files with `gracefig`)

**Debian or Ubuntu**

```sh
sudo apt-get install gfortran ghostscript libmotif-dev make python3-pip
```

**Fedora**

```sh
sudo dnf install gcc-gfortran ghostscript make motif-devel python3-pip
```


Installation
------------

Use [`pip`](https://pip.pypa.io/):
```sh
pip install python-grace
```
which installs the `grace` command.
(You may need to adjust `$PATH`.
You can always use `python -m grace`, instead.)

To select the compilers, specify them as environment variables when `pip` runs:
```sh
CC=gcc-12 FC=gfortran-12 pip install python-grace
```

You can use [`pipx`](https://pypa.github.io/pipx/) instead of `pip`
if you prefer to install this software in an isolated and/or temporary environment.


Example
-------

```sh
mkdir my_process
cd my_process
grace template sm/eewwa
grace grc
grace gracefig - # requires optional dependencies
grace grcfort
make all
./gauge
./integ
./spring
```


Development
-----------
```sh
poetry install
poetry run task prepare
```


License
-------

The code in this repository is covered under
[the MIT license](https://github.com/tueda/python-grace/blob/main/LICENSE).

Note that, however, the source code of the GRACE system is *not* MIT licensed.
Indeed, this repository itself does not contain any part of GRACE.
When you install this software, the source code distribution of GRACE will
automatically be downloaded from the original site.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tueda/python-grace",
    "name": "python-grace",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6.1,<4.0.0",
    "maintainer_email": "",
    "keywords": "particle physics,automatic calculation",
    "author": "Takahiro Ueda",
    "author_email": "tueda@st.seikei.ac.jp",
    "download_url": "https://files.pythonhosted.org/packages/b2/14/75d93af75fe03fb8094ea4db5eaeb0383342eea748f95d793c8013d5e8b8/python_grace-0.0.9.tar.gz",
    "platform": null,
    "description": "python-grace\n============\n\n[![Test](https://github.com/tueda/python-grace/workflows/Test/badge.svg?branch=main)](https://github.com/tueda/python-grace/actions?query=branch:main)\n[![PyPI version](https://badge.fury.io/py/python-grace.svg)](https://pypi.org/project/python-grace/)\n\nAn unofficial Python wrapper for [the GRACE system](https://minami-home.kek.jp/)\n(the public version for tree-level computations).\n\n*This is a pre-alpha version.*\n\n\nRequirements\n------------\n\n- Python >= 3.6.1\n- pip >= 19.0\n- C compiler\n- Fortran compiler\n- Make utility\n- X Window system (optional, for `gracefig` and `grcdraw`)\n- Motif Toolkit or its clone (optional, for `gracefig`)\n- `ps2pdf` in Ghostscript (optional, to generate PDF files with `gracefig`)\n\n**Debian or Ubuntu**\n\n```sh\nsudo apt-get install gfortran ghostscript libmotif-dev make python3-pip\n```\n\n**Fedora**\n\n```sh\nsudo dnf install gcc-gfortran ghostscript make motif-devel python3-pip\n```\n\n\nInstallation\n------------\n\nUse [`pip`](https://pip.pypa.io/):\n```sh\npip install python-grace\n```\nwhich installs the `grace` command.\n(You may need to adjust `$PATH`.\nYou can always use `python -m grace`, instead.)\n\nTo select the compilers, specify them as environment variables when `pip` runs:\n```sh\nCC=gcc-12 FC=gfortran-12 pip install python-grace\n```\n\nYou can use [`pipx`](https://pypa.github.io/pipx/) instead of `pip`\nif you prefer to install this software in an isolated and/or temporary environment.\n\n\nExample\n-------\n\n```sh\nmkdir my_process\ncd my_process\ngrace template sm/eewwa\ngrace grc\ngrace gracefig - # requires optional dependencies\ngrace grcfort\nmake all\n./gauge\n./integ\n./spring\n```\n\n\nDevelopment\n-----------\n```sh\npoetry install\npoetry run task prepare\n```\n\n\nLicense\n-------\n\nThe code in this repository is covered under\n[the MIT license](https://github.com/tueda/python-grace/blob/main/LICENSE).\n\nNote that, however, the source code of the GRACE system is *not* MIT licensed.\nIndeed, this repository itself does not contain any part of GRACE.\nWhen you install this software, the source code distribution of GRACE will\nautomatically be downloaded from the original site.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "An unofficial Python wrapper for the GRACE system.",
    "version": "0.0.9",
    "project_urls": {
        "Homepage": "https://github.com/tueda/python-grace",
        "Repository": "https://github.com/tueda/python-grace"
    },
    "split_keywords": [
        "particle physics",
        "automatic calculation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b21475d93af75fe03fb8094ea4db5eaeb0383342eea748f95d793c8013d5e8b8",
                "md5": "214de6960dc94d9638ad6ed090958f2c",
                "sha256": "530bd3e20f50a188b3b519374a938aad774b3960cbc6d98282e4d38b6052df92"
            },
            "downloads": -1,
            "filename": "python_grace-0.0.9.tar.gz",
            "has_sig": false,
            "md5_digest": "214de6960dc94d9638ad6ed090958f2c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6.1,<4.0.0",
            "size": 16004,
            "upload_time": "2023-08-15T06:14:43",
            "upload_time_iso_8601": "2023-08-15T06:14:43.792362Z",
            "url": "https://files.pythonhosted.org/packages/b2/14/75d93af75fe03fb8094ea4db5eaeb0383342eea748f95d793c8013d5e8b8/python_grace-0.0.9.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-15 06:14:43",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tueda",
    "github_project": "python-grace",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "python-grace"
}
        
Elapsed time: 0.09883s