x3cflux


Namex3cflux JSON
Version 3.0.0a0 PyPI version JSON
download
home_pageNone
SummaryPython interface for 13CFLUX
upload_time2025-08-20 23:16:19
maintainerNone
docs_urlNone
authorNone
requires_python>=3.9
licenseNone
keywords 13c-mfa mfa mass-spectrometry hpc
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            <img src="https://jugit.fz-juelich.de/IBG-1/ModSim/Fluxomics/13CFLUX/-/raw/develop/docs/source/images/banner.png" width=350>

[![pipeline status](https://jugit.fz-juelich.de/fluxomics/x3cflux/badges/develop/pipeline.svg)](https://jugit.fz-juelich.de/fluxomics/x3cflux/-/commits/develop)
[![coverage report](https://jugit.fz-juelich.de/fluxomics/x3cflux/badges/develop/coverage.svg)](https://jugit.fz-juelich.de/fluxomics/x3cflux/-/commits/develop)

is a high-performance simulator for isotopically stationary and non-stationary simulation of isotope labeling
experiments.

## Installation

### Python Package Index (PyPI)

The recommended way for practitioners to install *13CFLUX* is via *pip* from the Python Package Index. It is the most
careless and easy, but will be slightly slower than a source build. Just run

```shell
pip install x3cflux
```

It is recommended to do this in a Python environment.

### Source build

#### Requirements

The following requirements have to be met to install *13CFLUX*:

- C++17 capable compiler (currently supported: *gcc*, *clang*)
- *CMake* (>= 3.0)
- *Boost*: log, date time, unit test framework (>= 1.65)
- *FluxML* (compiled with --enable-pic to build the python wrapper)
- *OpenMP* (>= 3.0, optional)

#### PyProject build

The most easy way to install from source is to run

```shell
pip install .
```

in the root directory of the project. This will compile the project.

#### CMake build

Change into the project root directory and open a terminal. Then enter

```shell script
mkdir build && cd build
```

In the build directory run

```shell script
cmake ..
```

to configure *CMake*. You can supply this call with `-DBUILD_TESTS=ON` to enable testing or `-DBUILD_NATIVE=ON` to
optimize the binary to the compilation machine. After that you can build *13CFLUX* with

```shell script
cmake --build .
```

Open a terminal in the build directory and enter

```shell script
sudo make install
```

## Development

The development of *13CFLUX* primarily takes place on
[JuGit](https://jugit.fz-juelich.de/IBG-1/ModSim/Fluxomics/13CFLUX), where we have access to powerful continuous
integration and a Docker registry. The GitHub repository is only a mirror, so please report issues and make pull
requests on JuGit.

## Citing
            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "x3cflux",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": null,
    "keywords": "13C-MFA, MFA, mass-spectrometry, HPC",
    "author": null,
    "author_email": "Anton Stratmann <info@13cflux.net>, Martin Beyss <info@13cflux.net>, Katharina Noeh <info@13cflux.net>",
    "download_url": null,
    "platform": null,
    "description": "<img src=\"https://jugit.fz-juelich.de/IBG-1/ModSim/Fluxomics/13CFLUX/-/raw/develop/docs/source/images/banner.png\" width=350>\n\n[![pipeline status](https://jugit.fz-juelich.de/fluxomics/x3cflux/badges/develop/pipeline.svg)](https://jugit.fz-juelich.de/fluxomics/x3cflux/-/commits/develop)\n[![coverage report](https://jugit.fz-juelich.de/fluxomics/x3cflux/badges/develop/coverage.svg)](https://jugit.fz-juelich.de/fluxomics/x3cflux/-/commits/develop)\n\nis a high-performance simulator for isotopically stationary and non-stationary simulation of isotope labeling\nexperiments.\n\n## Installation\n\n### Python Package Index (PyPI)\n\nThe recommended way for practitioners to install *13CFLUX* is via *pip* from the Python Package Index. It is the most\ncareless and easy, but will be slightly slower than a source build. Just run\n\n```shell\npip install x3cflux\n```\n\nIt is recommended to do this in a Python environment.\n\n### Source build\n\n#### Requirements\n\nThe following requirements have to be met to install *13CFLUX*:\n\n- C++17 capable compiler (currently supported: *gcc*, *clang*)\n- *CMake* (>= 3.0)\n- *Boost*: log, date time, unit test framework (>= 1.65)\n- *FluxML* (compiled with --enable-pic to build the python wrapper)\n- *OpenMP* (>= 3.0, optional)\n\n#### PyProject build\n\nThe most easy way to install from source is to run\n\n```shell\npip install .\n```\n\nin the root directory of the project. This will compile the project.\n\n#### CMake build\n\nChange into the project root directory and open a terminal. Then enter\n\n```shell script\nmkdir build && cd build\n```\n\nIn the build directory run\n\n```shell script\ncmake ..\n```\n\nto configure *CMake*. You can supply this call with `-DBUILD_TESTS=ON` to enable testing or `-DBUILD_NATIVE=ON` to\noptimize the binary to the compilation machine. After that you can build *13CFLUX* with\n\n```shell script\ncmake --build .\n```\n\nOpen a terminal in the build directory and enter\n\n```shell script\nsudo make install\n```\n\n## Development\n\nThe development of *13CFLUX* primarily takes place on\n[JuGit](https://jugit.fz-juelich.de/IBG-1/ModSim/Fluxomics/13CFLUX), where we have access to powerful continuous\nintegration and a Docker registry. The GitHub repository is only a mirror, so please report issues and make pull\nrequests on JuGit.\n\n## Citing",
    "bugtrack_url": null,
    "license": null,
    "summary": "Python interface for 13CFLUX",
    "version": "3.0.0a0",
    "project_urls": {
        "documentation": "https://x3cflux.readthedocs.io",
        "homepage": "https://13cflux.net",
        "repository": "https://jugit.fz-juelich.de/IBG-1/ModSim/Fluxomics/13CFLUX"
    },
    "split_keywords": [
        "13c-mfa",
        " mfa",
        " mass-spectrometry",
        " hpc"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "11ec53b520b85dcc8feb30a48f7d71759dbf054346ed774f5a72992d82665719",
                "md5": "f7ca5ef0a653c056161631f4ab8f08ee",
                "sha256": "3594355bb2321a730ab2161b94c66724dfcbf9a55f4f4ff0bb9b2573164ecf46"
            },
            "downloads": -1,
            "filename": "x3cflux-3.0.0a0-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "has_sig": false,
            "md5_digest": "f7ca5ef0a653c056161631f4ab8f08ee",
            "packagetype": "bdist_wheel",
            "python_version": "cp310",
            "requires_python": ">=3.9",
            "size": 9232117,
            "upload_time": "2025-08-20T23:16:19",
            "upload_time_iso_8601": "2025-08-20T23:16:19.272836Z",
            "url": "https://files.pythonhosted.org/packages/11/ec/53b520b85dcc8feb30a48f7d71759dbf054346ed774f5a72992d82665719/x3cflux-3.0.0a0-cp310-cp310-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "b539437b05f3bf0c1093d469b2b71406d9d14f433290ce8beab94892b622325d",
                "md5": "b6dcfdc9c4d285925fce5bc182915e9d",
                "sha256": "9e919898f4ae04d435c298a9594b1df1074ae62e29932d53ac9f2b0354e3cdb3"
            },
            "downloads": -1,
            "filename": "x3cflux-3.0.0a0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "has_sig": false,
            "md5_digest": "b6dcfdc9c4d285925fce5bc182915e9d",
            "packagetype": "bdist_wheel",
            "python_version": "cp311",
            "requires_python": ">=3.9",
            "size": 9231096,
            "upload_time": "2025-08-20T23:16:22",
            "upload_time_iso_8601": "2025-08-20T23:16:22.001788Z",
            "url": "https://files.pythonhosted.org/packages/b5/39/437b05f3bf0c1093d469b2b71406d9d14f433290ce8beab94892b622325d/x3cflux-3.0.0a0-cp311-cp311-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "96d65c89a0e118c30a5d33b16473d5de955912c64c9aae2ee9beca614da89a94",
                "md5": "f789a4c87bb1dbab4d8a955a1b43970b",
                "sha256": "da9d27defd680a214a8c0837f0cb0255bf30c47e1b06e0bc8b3acf35c42a54f5"
            },
            "downloads": -1,
            "filename": "x3cflux-3.0.0a0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "has_sig": false,
            "md5_digest": "f789a4c87bb1dbab4d8a955a1b43970b",
            "packagetype": "bdist_wheel",
            "python_version": "cp312",
            "requires_python": ">=3.9",
            "size": 9223107,
            "upload_time": "2025-08-20T23:16:24",
            "upload_time_iso_8601": "2025-08-20T23:16:24.428379Z",
            "url": "https://files.pythonhosted.org/packages/96/d6/5c89a0e118c30a5d33b16473d5de955912c64c9aae2ee9beca614da89a94/x3cflux-3.0.0a0-cp312-cp312-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "2b2b6829031a83c14c9be62487c12a3a97bcb0fe8502aa7ab67005b1359804f8",
                "md5": "4f10ff554cbb3a51dc373aca22af7b52",
                "sha256": "b14ceec61dad0188d787e7e34385f0dabe2797f68eb81d72e32a8de68b235a9d"
            },
            "downloads": -1,
            "filename": "x3cflux-3.0.0a0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "has_sig": false,
            "md5_digest": "4f10ff554cbb3a51dc373aca22af7b52",
            "packagetype": "bdist_wheel",
            "python_version": "cp313",
            "requires_python": ">=3.9",
            "size": 9223579,
            "upload_time": "2025-08-20T23:16:27",
            "upload_time_iso_8601": "2025-08-20T23:16:27.029850Z",
            "url": "https://files.pythonhosted.org/packages/2b/2b/6829031a83c14c9be62487c12a3a97bcb0fe8502aa7ab67005b1359804f8/x3cflux-3.0.0a0-cp313-cp313-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "4e260144c6956ab9b2625b24b9bf3bfeb3c683227c190630c58fb1f58db65f34",
                "md5": "997584df62c8c4097a997542287f5e0d",
                "sha256": "99292106b91731a5294bc7af09dbef74302d18912b1a6b5c26c87acef22c49bc"
            },
            "downloads": -1,
            "filename": "x3cflux-3.0.0a0-cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "has_sig": false,
            "md5_digest": "997584df62c8c4097a997542287f5e0d",
            "packagetype": "bdist_wheel",
            "python_version": "cp39",
            "requires_python": ">=3.9",
            "size": 9230583,
            "upload_time": "2025-08-20T23:16:29",
            "upload_time_iso_8601": "2025-08-20T23:16:29.670342Z",
            "url": "https://files.pythonhosted.org/packages/4e/26/0144c6956ab9b2625b24b9bf3bfeb3c683227c190630c58fb1f58db65f34/x3cflux-3.0.0a0-cp39-cp39-manylinux2014_x86_64.manylinux_2_17_x86_64.whl",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-08-20 23:16:19",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "x3cflux"
}
        
Elapsed time: 0.65555s