| Name | pylarid JSON |
| Version |
0.1.dev0
JSON |
| download |
| home_page | |
| Summary | Load Arrays of Imaging Data |
| upload_time | 2023-11-13 04:15:53 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | |
| license | MIT License |
| keywords |
mri
fmri
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pylarid: Load Arrays of Imaging Data
`pylarid` is a Python package that is intended to facilitate analysis of
magnetic resonance imaging (MRI) data.
# Building Pylarid
`pylarid` consists of an extension module built in C++ to run on Python 3.
`pylarid` is currently tested using Python 3.12 on macOS Sonoma using Clang
and on Windows 11 using Visual Studio, and using Python 3.11 on Arch Linux
using GCC.
To build and install `pylarid` from source, [CMake](https://cmake.org) and a
compiler that supports C++20 are required.
## Build using PyPA's build (Recommended)
Preferably, this is done in a virtual environment. If using Visual Studio, use
a 64-bit native tools developer command prompt. First, install the most
up-to-date versions of `pip` and `pipx` in the virtual environment.
```
python -m pip install --upgrade pip
pip install --upgrade pipx
```
Next, obtain the [pylarid](https://github.com/jme2041/pylarid.git) source code,
build, and install.
```
git clone git@github.com:jme2041/pylarid.git
cd pylarid
pipx run build --wheel -Cbuild-dir=build
pip install .
```
Note that `-Cbuild-dir=build` sets the temporary directory to `build`. This is
optional, but recommended for speeding up builds and for avoiding warnings
about the intermediate directory being temporary when building with Visual
Studio (warning MSB8029).
To uninstall, use `pip uninstall pylarid`.
## Manual Build Using CMake (advanced)
To build and install `pylarid` directly using CMake, create a `build` directory
within the `pylarid` directory and follow the normal steps for building and
installing software using CMake.
To build and install on macOS and Linux:
```
mkdir build
cd build
cmake ..
make
make install
```
To uninstall, use `make uninstall`.
To build and install on Windows using Visual Studio:
```
mkdir build
cd build
cmake ..
cmake --build . --config Release
cmake --build . --config Release --target install
```
To uninstall, use `cmake --build . --config Release --target uninstall`.
# Research and Educational Use Only
`pylarid` is for research and educational purposes only. Clinical applications
are not recommended or advised. `pylarid` has not been evaluated by the United
States Food and Drug Administration (FDA), or by any other agency. `pylarid` is
not intended to diagnose, treat, cure, or prevent any disease.
# License
Copyright 2023 Jeffrey M. Engelmann
`pylarid` is released under the MIT license. For details, see
[LICENSE.txt](LICENSE.txt).
Raw data
{
"_id": null,
"home_page": "",
"name": "pylarid",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "mri fmri",
"author": "",
"author_email": "Jeffrey Michael Engelmann <jme2041@icloud.com>",
"download_url": "https://files.pythonhosted.org/packages/fa/7c/cde4443e0e39701589c83a7cb3cdd13425fdb0c53128b3799458572e6589/pylarid-0.1.dev0.tar.gz",
"platform": null,
"description": "# pylarid: Load Arrays of Imaging Data\n\n`pylarid` is a Python package that is intended to facilitate analysis of\nmagnetic resonance imaging (MRI) data.\n\n# Building Pylarid\n\n`pylarid` consists of an extension module built in C++ to run on Python 3.\n`pylarid` is currently tested using Python 3.12 on macOS Sonoma using Clang\nand on Windows 11 using Visual Studio, and using Python 3.11 on Arch Linux\nusing GCC.\n\nTo build and install `pylarid` from source, [CMake](https://cmake.org) and a\ncompiler that supports C++20 are required.\n\n## Build using PyPA's build (Recommended)\n\nPreferably, this is done in a virtual environment. If using Visual Studio, use\na 64-bit native tools developer command prompt. First, install the most\nup-to-date versions of `pip` and `pipx` in the virtual environment.\n\n```\npython -m pip install --upgrade pip\npip install --upgrade pipx\n```\n\nNext, obtain the [pylarid](https://github.com/jme2041/pylarid.git) source code,\nbuild, and install.\n\n```\ngit clone git@github.com:jme2041/pylarid.git\ncd pylarid\npipx run build --wheel -Cbuild-dir=build\npip install .\n```\n\nNote that `-Cbuild-dir=build` sets the temporary directory to `build`. This is\noptional, but recommended for speeding up builds and for avoiding warnings\nabout the intermediate directory being temporary when building with Visual\nStudio (warning MSB8029).\n\nTo uninstall, use `pip uninstall pylarid`.\n\n## Manual Build Using CMake (advanced)\n\nTo build and install `pylarid` directly using CMake, create a `build` directory\nwithin the `pylarid` directory and follow the normal steps for building and\ninstalling software using CMake.\n\nTo build and install on macOS and Linux:\n\n```\nmkdir build\ncd build\ncmake ..\nmake\nmake install\n```\n\nTo uninstall, use `make uninstall`.\n\nTo build and install on Windows using Visual Studio:\n\n```\nmkdir build\ncd build\ncmake ..\ncmake --build . --config Release\ncmake --build . --config Release --target install\n```\n\nTo uninstall, use `cmake --build . --config Release --target uninstall`.\n\n# Research and Educational Use Only\n\n`pylarid` is for research and educational purposes only. Clinical applications\nare not recommended or advised. `pylarid` has not been evaluated by the United\nStates Food and Drug Administration (FDA), or by any other agency. `pylarid` is\nnot intended to diagnose, treat, cure, or prevent any disease.\n\n# License\n\nCopyright 2023 Jeffrey M. Engelmann\n\n`pylarid` is released under the MIT license. For details, see\n[LICENSE.txt](LICENSE.txt).\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Load Arrays of Imaging Data",
"version": "0.1.dev0",
"project_urls": {
"Repository": "https://github.com/jme2041/pylarid.git"
},
"split_keywords": [
"mri",
"fmri"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "46d4ec7222531efc8e2c5138e17df733a940b6ff5724a67706589f20374888a7",
"md5": "dd9b801f8f01ff604408ac3446403950",
"sha256": "449fd508ac7cec4991f86e5afc66c930b736a518321478242e13c2571e50fe06"
},
"downloads": -1,
"filename": "pylarid-0.1.dev0-cp312-cp312-macosx_14_0_arm64.whl",
"has_sig": false,
"md5_digest": "dd9b801f8f01ff604408ac3446403950",
"packagetype": "bdist_wheel",
"python_version": "cp312",
"requires_python": null,
"size": 5728,
"upload_time": "2023-11-13T04:15:51",
"upload_time_iso_8601": "2023-11-13T04:15:51.486739Z",
"url": "https://files.pythonhosted.org/packages/46/d4/ec7222531efc8e2c5138e17df733a940b6ff5724a67706589f20374888a7/pylarid-0.1.dev0-cp312-cp312-macosx_14_0_arm64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa7ccde4443e0e39701589c83a7cb3cdd13425fdb0c53128b3799458572e6589",
"md5": "e7387eeb579241210b1e5816adda13a6",
"sha256": "f31b83a2713b3ac1a4d208d924bcd598477f7b8a2aa755a5c9b3447b4e685bc3"
},
"downloads": -1,
"filename": "pylarid-0.1.dev0.tar.gz",
"has_sig": false,
"md5_digest": "e7387eeb579241210b1e5816adda13a6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6606,
"upload_time": "2023-11-13T04:15:53",
"upload_time_iso_8601": "2023-11-13T04:15:53.181025Z",
"url": "https://files.pythonhosted.org/packages/fa/7c/cde4443e0e39701589c83a7cb3cdd13425fdb0c53128b3799458572e6589/pylarid-0.1.dev0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-13 04:15:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "jme2041",
"github_project": "pylarid",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pylarid"
}
