| Name | murfey JSON |
| Version |
0.11.10
JSON |
| download |
| home_page | None |
| Summary | Client-Server architecture hauling Cryo-EM data |
| upload_time | 2024-04-24 09:19:39 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Copyright (c) 2022 Diamond Light Source. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 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. 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 OWNER 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.
|
# Murfey
A transporter for data from Diamond eBIC microscope and detector machines onto the Diamond network.
### Who is Murfey?
Murfey, the package, is named after [Eliza Murfey, the inventor](https://nationalrrmuseum.org/blog/mother-of-invention-women-railroad-innovators/):
> Focusing on the mechanics of the railroad, inventor Eliza Murfey created devices designed
> to improve the bearings on rail wheels. With sixteen patents for her lubrication system,
> it was Murfey who designed the packings that would lubricate the axles with oil, aiding
> in the reduction of derailments caused by seized axles and bearings.
### How do I set up a development environment?
We suggest you start with your favourite virtual environment (mamba/conda/python virtualenv/...),
then install the dependencies listed in `requirements_dev.txt` with eg.
```bash
$ git clone git@github.com:DiamondLightSource/python-murfey.git
$ cd python-murfey
$ pip install -r requirements_dev.txt
$ pip install -e .[client,server]
```
You will also want to set up pre-commits:
```bash
$ pip install pre-commit
$ pre-commit install
```
Finally, you may want to set up an ISPyB mock database server and a Zocalo
development environment. The instructions for this are out of scope here.
You can then start the Murfey server with
```bash
$ murfey.server
```
and connect the client with
```bash
$ murfey --server http://127.0.0.1:8000
```
You can also install a client on a remote machine. This machine only needs to have
a minimum Python installation and curl. Open the murfey server website in a browser
on the client, and navigate to the bootstrap page. Then copy the displayed commands
into a command line terminal.
Raw data
{
"_id": null,
"home_page": null,
"name": "murfey",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/cb/75/577f734dba3fbd5edb938746859d6853fab2ca3c89369f12f4228999e632/murfey-0.11.10.tar.gz",
"platform": null,
"description": "# Murfey\n\nA transporter for data from Diamond eBIC microscope and detector machines onto the Diamond network.\n\n### Who is Murfey?\n\nMurfey, the package, is named after [Eliza Murfey, the inventor](https://nationalrrmuseum.org/blog/mother-of-invention-women-railroad-innovators/):\n\n> Focusing on the mechanics of the railroad, inventor Eliza Murfey created devices designed\n> to improve the bearings on rail wheels. With sixteen patents for her lubrication system,\n> it was Murfey who designed the packings that would lubricate the axles with oil, aiding\n> in the reduction of derailments caused by seized axles and bearings.\n\n### How do I set up a development environment?\n\nWe suggest you start with your favourite virtual environment (mamba/conda/python virtualenv/...),\nthen install the dependencies listed in `requirements_dev.txt` with eg.\n\n```bash\n$ git clone git@github.com:DiamondLightSource/python-murfey.git\n$ cd python-murfey\n$ pip install -r requirements_dev.txt\n$ pip install -e .[client,server]\n```\n\nYou will also want to set up pre-commits:\n\n```bash\n$ pip install pre-commit\n$ pre-commit install\n```\n\nFinally, you may want to set up an ISPyB mock database server and a Zocalo\ndevelopment environment. The instructions for this are out of scope here.\n\nYou can then start the Murfey server with\n\n```bash\n$ murfey.server\n```\n\nand connect the client with\n\n```bash\n$ murfey --server http://127.0.0.1:8000\n```\n\nYou can also install a client on a remote machine. This machine only needs to have\na minimum Python installation and curl. Open the murfey server website in a browser\non the client, and navigate to the bootstrap page. Then copy the displayed commands\ninto a command line terminal.\n",
"bugtrack_url": null,
"license": "Copyright (c) 2022 Diamond Light Source. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 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. 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 OWNER 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": "Client-Server architecture hauling Cryo-EM data",
"version": "0.11.10",
"project_urls": {
"Bug-Tracker": "https://github.com/DiamondLightSource/python-murfey/issues",
"Documentation": "https://github.com/DiamondLightSource/python-murfey",
"GitHub": "https://github.com/DiamondLightSource/python-murfey"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "eca22a24c685281d4b7e2a1c912782824ea15e24adb199276d74ea7aaadc423d",
"md5": "73e4efe60bf33db44dca65295798e14d",
"sha256": "72ffd0b6c6b39ea85e3fe009402720531baa53e74fe5ba7cca64d0f1e5dce87f"
},
"downloads": -1,
"filename": "murfey-0.11.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "73e4efe60bf33db44dca65295798e14d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 237800,
"upload_time": "2024-04-24T09:19:36",
"upload_time_iso_8601": "2024-04-24T09:19:36.852177Z",
"url": "https://files.pythonhosted.org/packages/ec/a2/2a24c685281d4b7e2a1c912782824ea15e24adb199276d74ea7aaadc423d/murfey-0.11.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb75577f734dba3fbd5edb938746859d6853fab2ca3c89369f12f4228999e632",
"md5": "9d6865e989f74a1a1963858c025468bc",
"sha256": "b91f34f63109198b6b32c7d6ea50c33308f7e626fc566d2fbd776aab5e0e03a5"
},
"downloads": -1,
"filename": "murfey-0.11.10.tar.gz",
"has_sig": false,
"md5_digest": "9d6865e989f74a1a1963858c025468bc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 216814,
"upload_time": "2024-04-24T09:19:39",
"upload_time_iso_8601": "2024-04-24T09:19:39.363034Z",
"url": "https://files.pythonhosted.org/packages/cb/75/577f734dba3fbd5edb938746859d6853fab2ca3c89369f12f4228999e632/murfey-0.11.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 09:19:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "DiamondLightSource",
"github_project": "python-murfey",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "murfey"
}
