pyfortool


Namepyfortool JSON
Version 0.2.1 PyPI version JSON
download
home_pageNone
SummaryPython-fortran-tool
upload_time2024-11-13 12:48:32
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseLICENSE
keywords fortran static-analysis
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Python-fortran-tool

This set of tools is primarily designed to be applied on the [PHYEX](https://github.com/UMR-CNRM/PHYEX)
repository. But they are normally generic enough to be used in other contexts.

The tools can be used with the command line (the pyfortool.py and pyfortool\_parallel.py utilities)
or as a python package. The documentation is in the doc directory and some examples are in the
examples directory. 

The fxtran binary is needed to use PyForTool. You can:
  - use an existing installation and make sure it can be found using your PATH variable;
  - use an existing installation providing the exact path with the '--parser' option;
  - automatically install fxtran using the INSTALL.sh script (installation method #1 below)

Prerequisites:
  - an internet connexion (with access to the github servers) is needed only for the installation of fxtran
  - python > 3.8 (but only tested with version 3.10)
  - a C compiler (tested with cc 11.4.0) to compile fxtran
  - some classical unix tools: make (for fxtran) and git

There are three installation methods, depending on your use.
Methods 2 and 3 needs an external installation of fxtran (which is not covered here).
On some systems, you may need to create a python virtual environment to use methods 2 and 3.

Method 1 (suitable for developpers and end users):
  - open a terminal on a system satisfying the prerequisites and enter the following commands
  - if you don't have a github ssh key or don't know what it is:
    > git clone https://github.com/UMR-CNRM/pyfortool.git
    > ./pyfortool/bin/INSTALL.sh
  - if you have a github ssh key:
    > git clone git@github.com:UMR-CNRM/pyfortool.git
    > ./pyfortool/bin/INSTALL.sh --ssh
  - then:
    > source pyfortool/bin/env.sh # to set PATH and PYTHONPATH

Method 2 (suitable for developpers and end users):
  - open a terminal on a system satisfying the prerequisites and enter the following commands
  - if you don't have a github ssh key or don't know what it is:
    > git clone https://github.com/UMR-CNRM/pyfortool.git
  - if you have a github ssh key:
    > git clone git@github.com:UMR-CNRM/pyfortool.git
  - > cd pyfortool; python3 -m pip install -e .

Method 3 (suitable for users who do not develop PyForTool):
  - open a terminal on a system satisfying the prerequisites and enter the following commands
  - python3 -m pip install pyfortool

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "pyfortool",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "fortran, static-analysis",
    "author": null,
    "author_email": "Quentin Rodier <quentin.rodier@meteo.fr>, S\u00e9bastien Riette <sebastien.riette@meteo.Fr>",
    "download_url": null,
    "platform": null,
    "description": "# Python-fortran-tool\n\nThis set of tools is primarily designed to be applied on the [PHYEX](https://github.com/UMR-CNRM/PHYEX)\nrepository. But they are normally generic enough to be used in other contexts.\n\nThe tools can be used with the command line (the pyfortool.py and pyfortool\\_parallel.py utilities)\nor as a python package. The documentation is in the doc directory and some examples are in the\nexamples directory. \n\nThe fxtran binary is needed to use PyForTool. You can:\n  - use an existing installation and make sure it can be found using your PATH variable;\n  - use an existing installation providing the exact path with the '--parser' option;\n  - automatically install fxtran using the INSTALL.sh script (installation method #1 below)\n\nPrerequisites:\n  - an internet connexion (with access to the github servers) is needed only for the installation of fxtran\n  - python > 3.8 (but only tested with version 3.10)\n  - a C compiler (tested with cc 11.4.0) to compile fxtran\n  - some classical unix tools: make (for fxtran) and git\n\nThere are three installation methods, depending on your use.\nMethods 2 and 3 needs an external installation of fxtran (which is not covered here).\nOn some systems, you may need to create a python virtual environment to use methods 2 and 3.\n\nMethod 1 (suitable for developpers and end users):\n  - open a terminal on a system satisfying the prerequisites and enter the following commands\n  - if you don't have a github ssh key or don't know what it is:\n    > git clone https://github.com/UMR-CNRM/pyfortool.git\n    > ./pyfortool/bin/INSTALL.sh\n  - if you have a github ssh key:\n    > git clone git@github.com:UMR-CNRM/pyfortool.git\n    > ./pyfortool/bin/INSTALL.sh --ssh\n  - then:\n    > source pyfortool/bin/env.sh # to set PATH and PYTHONPATH\n\nMethod 2 (suitable for developpers and end users):\n  - open a terminal on a system satisfying the prerequisites and enter the following commands\n  - if you don't have a github ssh key or don't know what it is:\n    > git clone https://github.com/UMR-CNRM/pyfortool.git\n  - if you have a github ssh key:\n    > git clone git@github.com:UMR-CNRM/pyfortool.git\n  - > cd pyfortool; python3 -m pip install -e .\n\nMethod 3 (suitable for users who do not develop PyForTool):\n  - open a terminal on a system satisfying the prerequisites and enter the following commands\n  - python3 -m pip install pyfortool\n",
    "bugtrack_url": null,
    "license": "LICENSE",
    "summary": "Python-fortran-tool",
    "version": "0.2.1",
    "project_urls": {
        "Documentation": "https://umr-cnrm.github.io/pyfortool",
        "Issues": "https://github.com/UMR-CNRM/pyfortool/issues",
        "Repository": "https://github.com/UMR-CNRM/pyfortool"
    },
    "split_keywords": [
        "fortran",
        " static-analysis"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "93cfeb5d6d17eebbf59bded527ae538bccdea100af01bc72446ebbf3d3a8c015",
                "md5": "94fca59820c6d38f4d7b9de5e6bddef8",
                "sha256": "5465fb2f60580c50f182ca23410bfbff5309228454de3c662a8a7b2da43a7515"
            },
            "downloads": -1,
            "filename": "pyfortool-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "94fca59820c6d38f4d7b9de5e6bddef8",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 112668,
            "upload_time": "2024-11-13T12:48:32",
            "upload_time_iso_8601": "2024-11-13T12:48:32.355581Z",
            "url": "https://files.pythonhosted.org/packages/93/cf/eb5d6d17eebbf59bded527ae538bccdea100af01bc72446ebbf3d3a8c015/pyfortool-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-13 12:48:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "UMR-CNRM",
    "github_project": "pyfortool",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pyfortool"
}
        
Elapsed time: 0.47687s