Pulserver
=========
|Coverage| |CI/CD| |License| |Codefactor| |Sphinx| |PyPi| |Black| |PythonVersion|
.. |Coverage| image:: https://codecov.io/gh/INFN-MRI/pulserver/graph/badge.svg?token=qtB53xANwI
:target: https://codecov.io/gh/INFN-MRI/pulserver
.. |CI/CD| image:: https://github.com/INFN-MRI/pulserver/workflows/CI-CD/badge.svg
:target: https://github.com/INFN-MRI/pulserver
.. |License| image:: https://img.shields.io/github/license/INFN-MRI/pulserver
:target: https://github.com/INFN-MRI/pulserver/blob/main/LICENSE.txt
.. |Codefactor| image:: https://www.codefactor.io/repository/github/INFN-MRI/pulserver/badge
:target: https://www.codefactor.io/repository/github/INFN-MRI/pulserver
.. |Sphinx| image:: https://img.shields.io/badge/docs-Sphinx-blue
:target: https://infn-mri.github.io/pulserver
.. |PyPi| image:: https://img.shields.io/pypi/v/pulserver
:target: https://pypi.org/project/pulserver
.. |Black| image:: https://img.shields.io/badge/style-black-black
.. |PythonVersion| image:: https://img.shields.io/badge/Python-%3E=3.10-blue?logo=python&logoColor=white
:target: https://python.org
Pulserver is a high-level wrapper over PyPulseq. It is designed to
improve MR sequence code organization and provide a bridge
between different Pulseq interpreter representations while providing
a familiar interface to PyPulseq user.
It also provide a server-based interface to enable online sequence design
routines, e.g., using the MR scanner as a client.
Features
--------
Installation
------------
Pulserver can be installed via pip:
.. code-block:: bash
pip install pulserver
Development
-----------
If you want to modifiy the Pulserver code base:
.. code-block:: bash
git clone https://github.com/INFN-MRI/pulservert.git
pip install -e ./pulserver
Usage
-----
TODO: add quick example
Testing
-------
To run the tests, execute the following command in the terminal:
.. code-block:: bash
pytest .
License
-------
This project is licensed under the MIT License.
Contributing
------------
Contributions are welcome! Please fork the repository and submit a pull request.
Raw data
{
"_id": null,
"home_page": null,
"name": "pulserver",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "pulseq, mri, sequence-design, pulse-sequences, mri-sequences",
"author": null,
"author_email": "Matteo Cencini <matteo.cencini@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/8f/d7/2a7755579ee33e8a9f5746cbd8e5567717fa98b60207d27fff237ac6fcf4/pulserver-0.1.12.tar.gz",
"platform": null,
"description": "Pulserver\n=========\n|Coverage| |CI/CD| |License| |Codefactor| |Sphinx| |PyPi| |Black| |PythonVersion|\n\n.. |Coverage| image:: https://codecov.io/gh/INFN-MRI/pulserver/graph/badge.svg?token=qtB53xANwI \n :target: https://codecov.io/gh/INFN-MRI/pulserver\n\n.. |CI/CD| image:: https://github.com/INFN-MRI/pulserver/workflows/CI-CD/badge.svg\n :target: https://github.com/INFN-MRI/pulserver\n\n.. |License| image:: https://img.shields.io/github/license/INFN-MRI/pulserver\n :target: https://github.com/INFN-MRI/pulserver/blob/main/LICENSE.txt\n\n.. |Codefactor| image:: https://www.codefactor.io/repository/github/INFN-MRI/pulserver/badge\n :target: https://www.codefactor.io/repository/github/INFN-MRI/pulserver\n\n.. |Sphinx| image:: https://img.shields.io/badge/docs-Sphinx-blue\n :target: https://infn-mri.github.io/pulserver\n\n.. |PyPi| image:: https://img.shields.io/pypi/v/pulserver\n :target: https://pypi.org/project/pulserver\n\n.. |Black| image:: https://img.shields.io/badge/style-black-black\n\n.. |PythonVersion| image:: https://img.shields.io/badge/Python-%3E=3.10-blue?logo=python&logoColor=white\n :target: https://python.org\n\nPulserver is a high-level wrapper over PyPulseq. It is designed to \nimprove MR sequence code organization and provide a bridge\nbetween different Pulseq interpreter representations while providing\na familiar interface to PyPulseq user.\n\nIt also provide a server-based interface to enable online sequence design\nroutines, e.g., using the MR scanner as a client.\n\nFeatures\n--------\n\n\n\nInstallation\n------------\nPulserver can be installed via pip:\n\n.. code-block:: bash\n\n pip install pulserver\n\nDevelopment\n-----------\nIf you want to modifiy the Pulserver code base:\n\n.. code-block:: bash\n\n git clone https://github.com/INFN-MRI/pulservert.git\n pip install -e ./pulserver\n\nUsage\n-----\n\nTODO: add quick example\n\nTesting\n-------\nTo run the tests, execute the following command in the terminal:\n\n.. code-block:: bash\n\n pytest .\n\nLicense\n-------\nThis project is licensed under the MIT License.\n\nContributing\n------------\nContributions are welcome! Please fork the repository and submit a pull request.\n",
"bugtrack_url": null,
"license": null,
"summary": "A PyPulseq-based client/server MR sequence design toolbox.",
"version": "0.1.12",
"project_urls": {
"Bug Reports": "https://github.com/INFN-MRI/pulserver/issues",
"Homepage": "https://github.com/INFN-MRI/pulserver",
"Source": "https://github.com/INFN-MRI/pulserver"
},
"split_keywords": [
"pulseq",
" mri",
" sequence-design",
" pulse-sequences",
" mri-sequences"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1e1a220b8e0fa922753c6e376f21d2cd6742e2a09f926b5f37c8ea8ec3f0ec84",
"md5": "f4f1686989dc354018cd716b17e320b6",
"sha256": "6fba1fcbd6b3e0e203864c9d85d4ca74294f8081c39c6c1f92c658df2a0f6e06"
},
"downloads": -1,
"filename": "pulserver-0.1.12-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f4f1686989dc354018cd716b17e320b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 123585,
"upload_time": "2024-10-31T15:55:09",
"upload_time_iso_8601": "2024-10-31T15:55:09.235476Z",
"url": "https://files.pythonhosted.org/packages/1e/1a/220b8e0fa922753c6e376f21d2cd6742e2a09f926b5f37c8ea8ec3f0ec84/pulserver-0.1.12-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8fd72a7755579ee33e8a9f5746cbd8e5567717fa98b60207d27fff237ac6fcf4",
"md5": "3a15d9a1b50e2951ed12c6a4e3b7a8d2",
"sha256": "87f1e12465a07b29084554597f4cdfaeb76636cce5e0c4d12ba6f0d817541629"
},
"downloads": -1,
"filename": "pulserver-0.1.12.tar.gz",
"has_sig": false,
"md5_digest": "3a15d9a1b50e2951ed12c6a4e3b7a8d2",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 149362,
"upload_time": "2024-10-31T15:55:11",
"upload_time_iso_8601": "2024-10-31T15:55:11.295093Z",
"url": "https://files.pythonhosted.org/packages/8f/d7/2a7755579ee33e8a9f5746cbd8e5567717fa98b60207d27fff237ac6fcf4/pulserver-0.1.12.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-31 15:55:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "INFN-MRI",
"github_project": "pulserver",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pulserver"
}
JSON
