| Name | haven-spc JSON |
| Version |
2024.11.0
JSON |
| download |
| home_page | None |
| Summary | Tools and GUI for running the spectroscopy group beamlines at the Advanced Photon Source. |
| upload_time | 2024-11-20 18:09:37 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | None |
| keywords |
synchrotron
xray
bluesky
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Haven
[](https://haven-spc.readthedocs.io/en/latest/?badge=latest)
[](https://github.com/psf/black)
[](https://opensource.org/licenses/BSD-3-Clause)
Bluesky tools for beamlines managed by the spectroscopy group.
"Don't fly in anything with a Capissen 38 engine, they fall right out
of the sky."
## Installation
### Python Packing Index
Easiest way to install haven is using pip.
```
$ python -m pip install 'haven-spc'
```
### Development (Conda)
*haven* can also use *mamba* for dependency management, and
*setuptools* for installation and development.
First, download the package from github:
```bash
$ git clone https://github.com/spc-group/haven.git
$ cd haven
```
Then create the conda environment with mamba:
```bash
$ mamba env create -f environment.yml -n haven
```
lastly install the package, in developer mode:
```bash
$ conda activate haven
$ pip install -e ".[dev]"
```
## Usage
The easiest way to start **haven** is to use IPython's magic run command.
```
$ ipython
In [1]: %run -m haven.ipython_startup
```
This will load some common tools, and print some useful information
about how to use Haven.
## Running Tests
To run tests, run
```
$ pytest
```
# firefly
User-facing applications for controlling the beamlines managed by the
spectroscopy group. Be sure to include the [gui] extras if you plan
to use the GUI.
```
$ python -m pip install 'haven-spc[gui]'
$ firefly
```
# Versioning
Haven/Firefly uses calendar versioning, with short year and short
month for the MAJOR and MINOR versions, then a incremental MICRO
version. For example, version *2024.7.2* is the 3rd (*2*) release in
July (*7*) 2023 (*23*).
# Packaging
## Python Package Index (PyPI)
To deploy to PyPI:
```
$ python -m build
$ python -m twine check dist/*
$ python -m twine upload dist/*
Raw data
{
"_id": null,
"home_page": null,
"name": "haven-spc",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "synchrotron, xray, bluesky",
"author": null,
"author_email": "Mark Wolfman <wolfman@anl.gov>",
"download_url": "https://files.pythonhosted.org/packages/43/bf/01c7a9c541b47148c7e442bc463c9796ff6029716c4c29e0d7d03d52f264/haven_spc-2024.11.0.tar.gz",
"platform": null,
"description": "# Haven\n\n\n[](https://haven-spc.readthedocs.io/en/latest/?badge=latest)\n[](https://github.com/psf/black)\n[](https://opensource.org/licenses/BSD-3-Clause)\n\nBluesky tools for beamlines managed by the spectroscopy group.\n\n\"Don't fly in anything with a Capissen 38 engine, they fall right out\nof the sky.\"\n\n\n## Installation\n\n### Python Packing Index\n\nEasiest way to install haven is using pip.\n\n```\n$ python -m pip install 'haven-spc'\n```\n\n### Development (Conda)\n\n*haven* can also use *mamba* for dependency management, and\n*setuptools* for installation and development.\n\nFirst, download the package from github:\n\n```bash\n$ git clone https://github.com/spc-group/haven.git\n$ cd haven\n```\n\nThen create the conda environment with mamba:\n\n```bash\n$ mamba env create -f environment.yml -n haven\n```\n\nlastly install the package, in developer mode:\n\n```bash\n$ conda activate haven\n$ pip install -e \".[dev]\"\n```\n\n## Usage\n\nThe easiest way to start **haven** is to use IPython's magic run command.\n\n```\n$ ipython\nIn [1]: %run -m haven.ipython_startup\n```\n\nThis will load some common tools, and print some useful information\nabout how to use Haven.\n\n## Running Tests\n\nTo run tests, run\n\n```\n$ pytest\n```\n\n# firefly\n\nUser-facing applications for controlling the beamlines managed by the\nspectroscopy group. Be sure to include the [gui] extras if you plan\nto use the GUI.\n\n```\n$ python -m pip install 'haven-spc[gui]'\n$ firefly\n```\n\n# Versioning\n\nHaven/Firefly uses calendar versioning, with short year and short\nmonth for the MAJOR and MINOR versions, then a incremental MICRO\nversion. For example, version *2024.7.2* is the 3rd (*2*) release in\nJuly (*7*) 2023 (*23*).\n\n# Packaging\n\n## Python Package Index (PyPI)\n\nTo deploy to PyPI:\n\n```\n$ python -m build\n$ python -m twine check dist/*\n$ python -m twine upload dist/*\n",
"bugtrack_url": null,
"license": null,
"summary": "Tools and GUI for running the spectroscopy group beamlines at the Advanced Photon Source.",
"version": "2024.11.0",
"project_urls": {
"Bug Tracker": "https://github.com/spc-group/haven/issues",
"Homepage": "https://haven-spc.readthedocs.io/en/latest/"
},
"split_keywords": [
"synchrotron",
" xray",
" bluesky"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3c49a2e79399e51bc0d2c5728be8356d82980fd40428d838fae4b37751284995",
"md5": "78942839f24056c1d879b37f73f605e0",
"sha256": "cbfd6c912e1f1c721ae7296b9414ba98d0b59d588e991e1361be1833575cc84a"
},
"downloads": -1,
"filename": "haven_spc-2024.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "78942839f24056c1d879b37f73f605e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 3336284,
"upload_time": "2024-11-20T18:09:33",
"upload_time_iso_8601": "2024-11-20T18:09:33.410415Z",
"url": "https://files.pythonhosted.org/packages/3c/49/a2e79399e51bc0d2c5728be8356d82980fd40428d838fae4b37751284995/haven_spc-2024.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "43bf01c7a9c541b47148c7e442bc463c9796ff6029716c4c29e0d7d03d52f264",
"md5": "79aa606e18f07c2d0be92c353795de93",
"sha256": "9194c9ad0e6919b5bcdaf13744dfd0796660f321dc3e7848d4abd51d268d87d8"
},
"downloads": -1,
"filename": "haven_spc-2024.11.0.tar.gz",
"has_sig": false,
"md5_digest": "79aa606e18f07c2d0be92c353795de93",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 3355412,
"upload_time": "2024-11-20T18:09:37",
"upload_time_iso_8601": "2024-11-20T18:09:37.994331Z",
"url": "https://files.pythonhosted.org/packages/43/bf/01c7a9c541b47148c7e442bc463c9796ff6029716c4c29e0d7d03d52f264/haven_spc-2024.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-20 18:09:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "spc-group",
"github_project": "haven",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "haven-spc"
}
