# trx-python
This is a Python implementation of the trx file-format for tractography data.
For details, please visit the documentation web-page at https://tee-ar-ex.github.io/trx-python/.
To install this, you can run:
pip install trx-python
Or, to install from source:
git clone https://github.com/tee-ar-ex/trx-python.git
cd trx-python
pip install .
### Temporary Directory
The TRX file format uses memmaps to limit RAM usage. When dealing with large files this means several gigabytes could be required on disk (instead of RAM).
By default, the temporary directory on Linux and MacOS is `/tmp` and on Windows it should be `C:\WINDOWS\Temp`.
If you wish to change the directory add the following variable to your script or to your .bashrc or .bash_profile:
`export TRX_TMPDIR=/WHERE/I/WANT/MY/TMP/DATA` (a)
OR
`export TRX_TMPDIR=use_working_dir` (b)
The provided folder must already exists (a). `use_working_dir` will be the directory where the code is being executed from (b).
The temporary folders should be automatically cleaned. But, if the code crash unexpectedly, make sure the folders are deleted.
Raw data
{
"_id": null,
"home_page": "https://github.com/tee-ar-ex/trx-python",
"name": "trx-python",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/3c/3c/bd39a7898799bd9d161b895830a0c730baeb815f6fbc79a6c36ea0f094ad/trx-python-0.2.9.tar.gz",
"platform": "OS Independent",
"description": "# trx-python\n\nThis is a Python implementation of the trx file-format for tractography data.\n\nFor details, please visit the documentation web-page at https://tee-ar-ex.github.io/trx-python/.\n\nTo install this, you can run:\n\n pip install trx-python\n\nOr, to install from source:\n\n git clone https://github.com/tee-ar-ex/trx-python.git\n cd trx-python\n pip install .\n\n### Temporary Directory\nThe TRX file format uses memmaps to limit RAM usage. When dealing with large files this means several gigabytes could be required on disk (instead of RAM). \n\nBy default, the temporary directory on Linux and MacOS is `/tmp` and on Windows it should be `C:\\WINDOWS\\Temp`.\n\nIf you wish to change the directory add the following variable to your script or to your .bashrc or .bash_profile:\n`export TRX_TMPDIR=/WHERE/I/WANT/MY/TMP/DATA` (a)\nOR\n`export TRX_TMPDIR=use_working_dir` (b)\n\nThe provided folder must already exists (a). `use_working_dir` will be the directory where the code is being executed from (b).\n\nThe temporary folders should be automatically cleaned. But, if the code crash unexpectedly, make sure the folders are deleted.\n",
"bugtrack_url": null,
"license": "BSD License",
"summary": "Experiments with new file format for tractography",
"version": "0.2.9",
"project_urls": {
"Homepage": "https://github.com/tee-ar-ex/trx-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "23551a0953ffa30078aac893bff6b4e5ac2942eb34201f7c4375433f3337540b",
"md5": "1abb3d0073cd12119c23bcac697b7bbe",
"sha256": "234438b7f103c49768ab98e5f46e7b2624327065cd23fbfce5e681c32e8b4a3f"
},
"downloads": -1,
"filename": "trx_python-0.2.9-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1abb3d0073cd12119c23bcac697b7bbe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 45512,
"upload_time": "2023-10-12T15:50:45",
"upload_time_iso_8601": "2023-10-12T15:50:45.169499Z",
"url": "https://files.pythonhosted.org/packages/23/55/1a0953ffa30078aac893bff6b4e5ac2942eb34201f7c4375433f3337540b/trx_python-0.2.9-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3c3cbd39a7898799bd9d161b895830a0c730baeb815f6fbc79a6c36ea0f094ad",
"md5": "dbf31fb6e2404404cbfdce356e6f365f",
"sha256": "16b4104d7c991879c601f60e8d587decac50ce60388aae8d0c754a92136d1caf"
},
"downloads": -1,
"filename": "trx-python-0.2.9.tar.gz",
"has_sig": false,
"md5_digest": "dbf31fb6e2404404cbfdce356e6f365f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 86016,
"upload_time": "2023-10-12T15:50:46",
"upload_time_iso_8601": "2023-10-12T15:50:46.486462Z",
"url": "https://files.pythonhosted.org/packages/3c/3c/bd39a7898799bd9d161b895830a0c730baeb815f6fbc79a6c36ea0f094ad/trx-python-0.2.9.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-12 15:50:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tee-ar-ex",
"github_project": "trx-python",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "trx-python"
}
JSON
