https://github.com/cnpem/sophys-cli-extensions
SIRIUS-specific extensions for the sophys-cli project, dealing with code customized to SIRIUS beamlines
https://github.com/cnpem/sophys-cli-extensions
Last synced: 3 months ago
JSON representation
SIRIUS-specific extensions for the sophys-cli project, dealing with code customized to SIRIUS beamlines
- Host: GitHub
- URL: https://github.com/cnpem/sophys-cli-extensions
- Owner: cnpem
- License: gpl-3.0
- Created: 2024-12-05T20:26:56.000Z (6 months ago)
- Default Branch: main
- Last Pushed: 2025-02-10T19:48:18.000Z (4 months ago)
- Last Synced: 2025-02-10T20:35:20.384Z (4 months ago)
- Language: Python
- Size: 154 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sophys-cli-extensions
A command-line client for the sophys project group.
This is the SIRIUS extensions for [sophys-cli-core](https://github.com/cnpem/sophys-cli-core). It contains custom logic and functionality for particular beamlines.
## Installation
To use it, you'll have to be in a valid Python environment (consider using [micromamba](https://mamba.readthedocs.io/en/latest/user_guide/micromamba.html)). In there, you'll need to do the following:
Normal installation (TODO: Create pre-built packages):
```bash
$ pip install git+https://github.com/cnpem/sophys-cli-extensions.git
```
Developer installation:
```bash
$ cd
$ git clone https://github.com/cnpem/sophys-cli-extensions.git
$ pip install -e sophys-cli-extensions
```
With that, you'll have access to the `sophys-cli` command in the environment you installed it. Furthermore, to use `sophys-cli` with a particular beamline configuration, you must also install the `sophys-` package in that environment. After that, to use that configuration, see the [Usage](#usage) section.
## Usage and development
For usage and development information, refer to the [`sophys-cli-core`](https://github.com/cnpem/sophys-cli-core?tab=readme-ov-file#usage) documentation.
These extensions make use of environment variables to configure host and port variables for connection with httpserver and redis. These environment variable names are defined in `sophys-cli-core`, under their root [`__init__.py`](https://github.com/cnpem/sophys-cli-core/blob/main/src/sophys/cli/core/__init__.py).