| Name | MBIRJAX JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | High-performance tomographic reconstruction |
| upload_time | 2024-05-24 17:24:29 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | BSD 3-Clause License Copyright (c) 2021, Charles A Bouman All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
.. docs-include-ref
mbirjax
=======
Model-Based Iterative Reconstruction (MBIR) for tomographic reconstruction that is based on the JAX programming language.
Full documentation is available at https://mbirjax.readthedocs.io .
..
Include more detailed description here.
Installing
----------
1. *Clone or download the repository:*
.. code-block::
git clone git@github.com:cabouman/mbirjax.git
2. Install the conda environment and package
a. Option 1: Clean install from dev_scripts
*******You can skip all other steps if you do a clean install.******
To do a clean install, use the command:
.. code-block::
cd dev_scripts
source clean_install_all.sh
b. Option 2: Manual install
1. *Create conda environment:*
Create a new conda environment named ``mbirjax`` using the following commands:
.. code-block::
conda create --name mbirjax python=3.10
conda activate mbirjax
pip install -r requirements.txt
Anytime you want to use this package, this ``mbirjax`` environment should be activated with the following:
.. code-block::
conda activate mbirjax
2. *Install mbirjax package:*
Navigate to the main directory ``mbirjax/`` and run the following:
.. code-block::
pip install .
To allow editing of the package source while using the package, use
.. code-block::
pip install -e .
Running Demo(s)
---------------
Run any of the available demo scripts with something like the following:
.. code-block::
python demo/<demo_file>.py
Raw data
{
"_id": null,
"home_page": null,
"name": "MBIRJAX",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "MBIRJAX development team <buzzard@purdue.edu>",
"download_url": "https://files.pythonhosted.org/packages/df/8b/97500987c11cd9208fdeda53b857a03fc45f22270993e604a0c35d6825cb/mbirjax-0.1.0.tar.gz",
"platform": null,
"description": ".. docs-include-ref\n\nmbirjax\n=======\nModel-Based Iterative Reconstruction (MBIR) for tomographic reconstruction that is based on the JAX programming language.\nFull documentation is available at https://mbirjax.readthedocs.io .\n\n..\n Include more detailed description here.\n\nInstalling\n----------\n1. *Clone or download the repository:*\n\n .. code-block::\n\n git clone git@github.com:cabouman/mbirjax.git\n\n2. Install the conda environment and package\n\n a. Option 1: Clean install from dev_scripts\n\n *******You can skip all other steps if you do a clean install.******\n\n To do a clean install, use the command:\n\n .. code-block::\n\n cd dev_scripts\n source clean_install_all.sh\n\n b. Option 2: Manual install\n\n 1. *Create conda environment:*\n\n Create a new conda environment named ``mbirjax`` using the following commands:\n\n .. code-block::\n\n conda create --name mbirjax python=3.10\n conda activate mbirjax\n pip install -r requirements.txt\n\n Anytime you want to use this package, this ``mbirjax`` environment should be activated with the following:\n\n .. code-block::\n\n conda activate mbirjax\n\n\n 2. *Install mbirjax package:*\n\n Navigate to the main directory ``mbirjax/`` and run the following:\n\n .. code-block::\n\n pip install .\n\n To allow editing of the package source while using the package, use\n\n .. code-block::\n\n pip install -e .\n\n\nRunning Demo(s)\n---------------\n\nRun any of the available demo scripts with something like the following:\n\n .. code-block::\n\n python demo/<demo_file>.py\n\n",
"bugtrack_url": null,
"license": "BSD 3-Clause License Copyright (c) 2021, Charles A Bouman All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ",
"summary": "High-performance tomographic reconstruction",
"version": "0.1.0",
"project_urls": {
"homepage": "https://mbirjax.readthedocs.io",
"source": "https://github.com/cabouman/mbirjax"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "a9faa799c054b6418303162d76f3702f9b49b33c0bc45f84d8cb0060de50ba4e",
"md5": "53d520785aaa6596da5caf058e4daee0",
"sha256": "f1c34e0d1e13186706c5808033aaae39e053785a883ae886f867720c042862fc"
},
"downloads": -1,
"filename": "MBIRJAX-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "53d520785aaa6596da5caf058e4daee0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 70038,
"upload_time": "2024-05-24T17:24:27",
"upload_time_iso_8601": "2024-05-24T17:24:27.415224Z",
"url": "https://files.pythonhosted.org/packages/a9/fa/a799c054b6418303162d76f3702f9b49b33c0bc45f84d8cb0060de50ba4e/MBIRJAX-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "df8b97500987c11cd9208fdeda53b857a03fc45f22270993e604a0c35d6825cb",
"md5": "072400b4dba54e6f5d7ab595ac304505",
"sha256": "001d19f63d32ec3fa2f3178efc58b4ed6d4f53f0589ba82c4a41516521cbeb67"
},
"downloads": -1,
"filename": "mbirjax-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "072400b4dba54e6f5d7ab595ac304505",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 52853,
"upload_time": "2024-05-24T17:24:29",
"upload_time_iso_8601": "2024-05-24T17:24:29.489508Z",
"url": "https://files.pythonhosted.org/packages/df/8b/97500987c11cd9208fdeda53b857a03fc45f22270993e604a0c35d6825cb/mbirjax-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-24 17:24:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "cabouman",
"github_project": "mbirjax",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mbirjax"
}
