x4i3


Namex4i3 JSON
Version 1.2.4 PyPI version JSON
download
home_pagehttps://github.com/afedynitch/x4i3/
SummaryA "simple" python interface to the EXFOR library
upload_time2023-05-11 13:23:50
maintainerAnatoli Fedynitch
docs_urlNone
authorDavid A. Brown (x4i3: Anatoli Fedynitch)
requires_python
license
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ![PyPI](https://img.shields.io/pypi/v/x4i3)
[![Build Status](https://dev.azure.com/afedynitch/NuclearTools/_apis/build/status/afedynitch.x4i3?branchName=master)](https://dev.azure.com/afedynitch/NuclearTools/_build/latest?definitionId=4&branchName=master)
![Azure DevOps releases](https://img.shields.io/azure-devops/release/afedynitch/66c7ff07-d4ed-41bb-b939-9ed4dd5d61f9/1/1)

# x4i3 - The EXFOR Interface [for Python 3]

This package `x4i3` is a fork of the original `x4i` developed by David A. Brown (LLNL, Livermore CA, 94550). This pure python software acts as an interface to [Experimental Nuclear Reaction Data (EXFOR)](https://www-nds.iaea.org/exfor/) that the [International Atomic Energy Agency (IAEA)](https://www-nds.iaea.org/nrdc/) actively maintains.

The database resembles a collection of experimental and evaluated nuclear data files in the EXFOR format (*.x4), a structured markup language. The mark-up language is quite complex and the data has legacy issues, such as data sets entered by hand or issues with the strict alignment criteria of FORTRAN-era punch cards. The documentation by David A. Brown describes a few basics of the format. Please use this [documentation](doc/x4i/x4i.pdf), the references therein and the other files in the [doc](doc) folder. Please also cite the papers about the database if you use these data in your research.

The main purpose of this fork is to ensure that such a valuable and complex tool does stays available. Also, the original link for this code is dead and Python 2 is deprecated. As a standalone pure Python package on pip, it may cure derived works from a potential GPL infection.  

### Latest release 1.2.0

Update to EXFOR database version dated 2021/03/08.

### History

This fork emerged originally in 2016 when we tried to benchmark current photo-nuclear interaction codes against experimental data in a project related to Ultra-High Energy Cosmic Rays. One paper that came out [has a quite useful plot (Figure 1)](https://www.nature.com/articles/s41598-017-05120-7). Actually, this figure is [an interactive matplotlib application](https://github.com/afedynitch/EXFOR_chart) that used the original `x4i` as a backend. When a box is clicked x4i gathers experimental data from EXFOR, applies some filtering and visualizes the data against pre-computed model predictions.

### Examples

Nothing very useful yet. To check out if the installation is successful, try:

        python examples/get-entry.py --data -s 10504002

It should print some fission cross section to stdout.

### Contributions

..are welcome. Also feel free to say hi since I don't know if there is a community who may find this interface useful.

Currently there is no development goals beyond basic maintenance.

### Requirements

- ~1 GB of hard drive space

### Installation

    pip install x4i3

Note that on first import ~600MB will be downloaded and 22k files will be decompressed to the data directory.

### Support tools

To reduce the weight of this package, the database management tools have been moved to a different project [`x4i3_tools`](https://github.com/afedynitch/x4i3_tools) since these are for advanced users anyways.

### Documentation

There is currently no separate documentation for `x4i3`. Please use the original [documentation](doc/x4i/x4i.pdf). The installation instruction are not valid anymore. There is a detailed but auto-generated [API-doc documentation](doc/x4i/). Untar and enjoy the `index.html` if you need this.

### Authors

*David A. Brown (LLNL)* (`x4i`)

*Anatoli Fedynitch* (`x4i3`)

### Copyright and license

This code is distributed under the [GNU General Public License (GPLv2) (see LICENSE)](LICENSE.txt) without any warranty or guaranty. The full disclaimer and license information is located in the [LICENSE](LICENCE.txt). Very unfortunately, the original code is GPLv2 infecting in a nontransparent way all derived works such as this. Be warned!

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/afedynitch/x4i3/",
    "name": "x4i3",
    "maintainer": "Anatoli Fedynitch",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "afedynitch@gmail.com",
    "keywords": "",
    "author": "David A. Brown (x4i3: Anatoli Fedynitch)",
    "author_email": "dbrown@bnl.gov",
    "download_url": "https://files.pythonhosted.org/packages/04/98/290f423615798f1f25ce73928f1d3070f2bd589280689d6b5ba0ade4d2fe/x4i3-1.2.4.tar.gz",
    "platform": null,
    "description": "![PyPI](https://img.shields.io/pypi/v/x4i3)\n[![Build Status](https://dev.azure.com/afedynitch/NuclearTools/_apis/build/status/afedynitch.x4i3?branchName=master)](https://dev.azure.com/afedynitch/NuclearTools/_build/latest?definitionId=4&branchName=master)\n![Azure DevOps releases](https://img.shields.io/azure-devops/release/afedynitch/66c7ff07-d4ed-41bb-b939-9ed4dd5d61f9/1/1)\n\n# x4i3 - The EXFOR Interface [for Python 3]\n\nThis package `x4i3` is a fork of the original `x4i` developed by David A. Brown (LLNL, Livermore CA, 94550). This pure python software acts as an interface to [Experimental Nuclear Reaction Data (EXFOR)](https://www-nds.iaea.org/exfor/) that the [International Atomic Energy Agency (IAEA)](https://www-nds.iaea.org/nrdc/) actively maintains.\n\nThe database resembles a collection of experimental and evaluated nuclear data files in the EXFOR format (*.x4), a structured markup language. The mark-up language is quite complex and the data has legacy issues, such as data sets entered by hand or issues with the strict alignment criteria of FORTRAN-era punch cards. The documentation by David A. Brown describes a few basics of the format. Please use this [documentation](doc/x4i/x4i.pdf), the references therein and the other files in the [doc](doc) folder. Please also cite the papers about the database if you use these data in your research.\n\nThe main purpose of this fork is to ensure that such a valuable and complex tool does stays available. Also, the original link for this code is dead and Python 2 is deprecated. As a standalone pure Python package on pip, it may cure derived works from a potential GPL infection.  \n\n### Latest release 1.2.0\n\nUpdate to EXFOR database version dated 2021/03/08.\n\n### History\n\nThis fork emerged originally in 2016 when we tried to benchmark current photo-nuclear interaction codes against experimental data in a project related to Ultra-High Energy Cosmic Rays. One paper that came out [has a quite useful plot (Figure 1)](https://www.nature.com/articles/s41598-017-05120-7). Actually, this figure is [an interactive matplotlib application](https://github.com/afedynitch/EXFOR_chart) that used the original `x4i` as a backend. When a box is clicked x4i gathers experimental data from EXFOR, applies some filtering and visualizes the data against pre-computed model predictions.\n\n### Examples\n\nNothing very useful yet. To check out if the installation is successful, try:\n\n        python examples/get-entry.py --data -s 10504002\n\nIt should print some fission cross section to stdout.\n\n### Contributions\n\n..are welcome. Also feel free to say hi since I don't know if there is a community who may find this interface useful.\n\nCurrently there is no development goals beyond basic maintenance.\n\n### Requirements\n\n- ~1 GB of hard drive space\n\n### Installation\n\n    pip install x4i3\n\nNote that on first import ~600MB will be downloaded and 22k files will be decompressed to the data directory.\n\n### Support tools\n\nTo reduce the weight of this package, the database management tools have been moved to a different project [`x4i3_tools`](https://github.com/afedynitch/x4i3_tools) since these are for advanced users anyways.\n\n### Documentation\n\nThere is currently no separate documentation for `x4i3`. Please use the original [documentation](doc/x4i/x4i.pdf). The installation instruction are not valid anymore. There is a detailed but auto-generated [API-doc documentation](doc/x4i/). Untar and enjoy the `index.html` if you need this.\n\n### Authors\n\n*David A. Brown (LLNL)* (`x4i`)\n\n*Anatoli Fedynitch* (`x4i3`)\n\n### Copyright and license\n\nThis code is distributed under the [GNU General Public License (GPLv2) (see LICENSE)](LICENSE.txt) without any warranty or guaranty. The full disclaimer and license information is located in the [LICENSE](LICENCE.txt). Very unfortunately, the original code is GPLv2 infecting in a nontransparent way all derived works such as this. Be warned!\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "A \"simple\" python interface to the EXFOR library",
    "version": "1.2.4",
    "project_urls": {
        "Homepage": "https://github.com/afedynitch/x4i3/"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "5841c6de129a91ad682028aa541f5b4bd0c5c2ce1d6f1d6e6332b236ac5f9172",
                "md5": "6b4064250692cf0165158d5a58228f48",
                "sha256": "c61fea07a9922acd4950f6a330622cd1766e493fa34567ce60876d652447e31d"
            },
            "downloads": -1,
            "filename": "x4i3-1.2.4-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6b4064250692cf0165158d5a58228f48",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 270096,
            "upload_time": "2023-05-11T13:23:48",
            "upload_time_iso_8601": "2023-05-11T13:23:48.702909Z",
            "url": "https://files.pythonhosted.org/packages/58/41/c6de129a91ad682028aa541f5b4bd0c5c2ce1d6f1d6e6332b236ac5f9172/x4i3-1.2.4-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0498290f423615798f1f25ce73928f1d3070f2bd589280689d6b5ba0ade4d2fe",
                "md5": "b379bfa9224c9e501af13901d09f24b1",
                "sha256": "3ec5dca1d1c810b06a3ec53dcaf68ffcdd7498d903fa7a53cb09c30749357a33"
            },
            "downloads": -1,
            "filename": "x4i3-1.2.4.tar.gz",
            "has_sig": false,
            "md5_digest": "b379bfa9224c9e501af13901d09f24b1",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 245755,
            "upload_time": "2023-05-11T13:23:50",
            "upload_time_iso_8601": "2023-05-11T13:23:50.761608Z",
            "url": "https://files.pythonhosted.org/packages/04/98/290f423615798f1f25ce73928f1d3070f2bd589280689d6b5ba0ade4d2fe/x4i3-1.2.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-05-11 13:23:50",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "afedynitch",
    "github_project": "x4i3",
    "github_fetch_exception": true,
    "lcname": "x4i3"
}
        
Elapsed time: 0.16528s