mx/Jungfraujoch
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 33 Wiki Activity

version 1.0.0-rc.28

Browse Source
This commit is contained in:
leonarski_f
2024-12-05 16:41:04 +01:00
parent 381e44e944
commit e5a775b4a3
159 changed files with 827 additions and 676 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/python_client/README.md
View File

@@ -1,4 +1,4 @@
# jfjochclient
# jfjoch-client
API to control Jungfraujoch developed by the Paul Scherrer Institute (Switzerland).
Jungfraujoch is a data acquisition and analysis system for pixel array detectors, primarly PSI JUNGFRAU.
Jungfraujoch uses FPGA boards to acquire data at high data rates.
@@ -6,8 +6,8 @@ Jungfraujoch uses FPGA boards to acquire data at high data rates.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0-rc.27
- Package version: 1.0.0-rc.27
- API version: 1.0.0-rc.28
- Package version: 1.0.0-rc.28
- Generator version: 7.8.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
@@ -21,13 +21,13 @@ Python 3.7+
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://gitlab.psi.ch/jungfraujoch/nextgendcu.git
pip install git+https://git.psi.ch/jungfraujoch/jungfraujoch.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://gitlab.psi.ch/jungfraujoch/nextgendcu.git`)
(you may need to run `pip` with root permission: `sudo pip install git+https://git.psi.ch/jungfraujoch/jungfraujoch.git`)
Then import the package:
```python
import jfjochclient
import jfjoch_client
```
### Setuptools
@@ -41,7 +41,7 @@ python setup.py install --user
Then import the package:
```python
import jfjochclient
import jfjoch_client
```
### Tests
@@ -54,22 +54,22 @@ Please follow the [installation procedure](#installation--usage) and then run th
```python
import jfjochclient
from jfjochclient.rest import ApiException
import jfjoch_client
from jfjoch_client.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to http://localhost:5232
# See configuration.py for a list of all supported configuration parameters.
configuration = jfjochclient.Configuration(
configuration = jfjoch_client.Configuration(
host = "http://localhost:5232"
)
# Enter a context with an instance of the API client
with jfjochclient.ApiClient(configuration) as api_client:
with jfjoch_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jfjochclient.DefaultApi(api_client)
api_instance = jfjoch_client.DefaultApi(api_client)
try:
# Cancel running data collection

2
docs/python_client/docs/AzimIntSettings.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.azim_int_settings import AzimIntSettings
from jfjoch_client.models.azim_int_settings import AzimIntSettings
# TODO update the JSON string below
json = "{}"

3
docs/python_client/docs/BrokerStatus.md
View File

@@ -7,11 +7,12 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**state** | **str** | |
**progress** | **float** | Progress of data collection (only available if receiving is running) | [optional]
**error_message** | **str** | Last error message in case detector is in the Error state This matters especially for async functions (start/initialize), where API won't return reason for the error during async operation. | [optional]
## Example
```python
from jfjochclient.models.broker_status import BrokerStatus
from jfjoch_client.models.broker_status import BrokerStatus
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/CalibrationStatisticsInner.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.calibration_statistics_inner import CalibrationStatisticsInner
from jfjoch_client.models.calibration_statistics_inner import CalibrationStatisticsInner
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/DatasetSettings.md
View File

@@ -35,7 +35,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.dataset_settings import DatasetSettings
from jfjoch_client.models.dataset_settings import DatasetSettings
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/DatasetSettingsUnitCell.md
View File

@@ -16,7 +16,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.dataset_settings_unit_cell import DatasetSettingsUnitCell
from jfjoch_client.models.dataset_settings_unit_cell import DatasetSettingsUnitCell
# TODO update the JSON string below
json = "{}"

760
docs/python_client/docs/DefaultApi.md
View File

File diff suppressed because it is too large Load Diff

2
docs/python_client/docs/Detector.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.detector import Detector
from jfjoch_client.models.detector import Detector
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/DetectorList.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.detector_list import DetectorList
from jfjoch_client.models.detector_list import DetectorList
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/DetectorListDetectorsInner.md
View File

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.detector_list_detectors_inner import DetectorListDetectorsInner
from jfjoch_client.models.detector_list_detectors_inner import DetectorListDetectorsInner
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/DetectorModule.md
View File

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.detector_module import DetectorModule
from jfjoch_client.models.detector_module import DetectorModule
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/DetectorSelection.md
View File

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.detector_selection import DetectorSelection
from jfjoch_client.models.detector_selection import DetectorSelection
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/DetectorSettings.md
View File

@@ -25,7 +25,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.detector_settings import DetectorSettings
from jfjoch_client.models.detector_settings import DetectorSettings
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/DetectorStatus.md
View File

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.detector_status import DetectorStatus
from jfjoch_client.models.detector_status import DetectorStatus
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/ErrorMessage.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.error_message import ErrorMessage
from jfjoch_client.models.error_message import ErrorMessage
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/FpgaStatusInner.md
View File

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.fpga_status_inner import FpgaStatusInner
from jfjoch_client.models.fpga_status_inner import FpgaStatusInner
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/ImageFormatSettings.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.image_format_settings import ImageFormatSettings
from jfjoch_client.models.image_format_settings import ImageFormatSettings
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/InstrumentMetadata.md
View File

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.instrument_metadata import InstrumentMetadata
from jfjoch_client.models.instrument_metadata import InstrumentMetadata
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/JfjochSettings.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.jfjoch_settings import JfjochSettings
from jfjoch_client.models.jfjoch_settings import JfjochSettings
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/JfjochStatistics.md
View File

@@ -23,7 +23,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.jfjoch_statistics import JfjochStatistics
from jfjoch_client.models.jfjoch_statistics import JfjochStatistics
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/MeasurementStatistics.md
View File

@@ -27,7 +27,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.measurement_statistics import MeasurementStatistics
from jfjoch_client.models.measurement_statistics import MeasurementStatistics
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/PcieDevicesInner.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.pcie_devices_inner import PcieDevicesInner
from jfjoch_client.models.pcie_devices_inner import PcieDevicesInner
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/PixelMaskStatistics.md
View File

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.pixel_mask_statistics import PixelMaskStatistics
from jfjoch_client.models.pixel_mask_statistics import PixelMaskStatistics
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/Plot.md
View File

@@ -13,7 +13,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.plot import Plot
from jfjoch_client.models.plot import Plot
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/Plots.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.plots import Plots
from jfjoch_client.models.plots import Plots
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/PreviewSettings.md
View File

@@ -17,7 +17,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.preview_settings import PreviewSettings
from jfjoch_client.models.preview_settings import PreviewSettings
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/RoiBox.md
View File

@@ -15,7 +15,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.roi_box import RoiBox
from jfjoch_client.models.roi_box import RoiBox
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/RoiBoxList.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.roi_box_list import RoiBoxList
from jfjoch_client.models.roi_box_list import RoiBoxList
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/RoiCircle.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.roi_circle import RoiCircle
from jfjoch_client.models.roi_circle import RoiCircle
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/RoiCircleList.md
View File

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.roi_circle_list import RoiCircleList
from jfjoch_client.models.roi_circle_list import RoiCircleList
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/RotationAxis.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.rotation_axis import RotationAxis
from jfjoch_client.models.rotation_axis import RotationAxis
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/SpotFindingSettings.md
View File

@@ -20,7 +20,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.spot_finding_settings import SpotFindingSettings
from jfjoch_client.models.spot_finding_settings import SpotFindingSettings
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/StandardDetectorGeometry.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.standard_detector_geometry import StandardDetectorGeometry
from jfjoch_client.models.standard_detector_geometry import StandardDetectorGeometry
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/ZeromqMetadataSettings.md
View File

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.zeromq_metadata_settings import ZeromqMetadataSettings
from jfjoch_client.models.zeromq_metadata_settings import ZeromqMetadataSettings
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/ZeromqPreviewSettings.md
View File

@@ -12,7 +12,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.zeromq_preview_settings import ZeromqPreviewSettings
from jfjoch_client.models.zeromq_preview_settings import ZeromqPreviewSettings
# TODO update the JSON string below
json = "{}"

2
docs/python_client/docs/ZeromqSettings.md
View File

@@ -14,7 +14,7 @@ Name | Type | Description | Notes
## Example
```python
from jfjochclient.models.zeromq_settings import ZeromqSettings
from jfjoch_client.models.zeromq_settings import ZeromqSettings
# TODO update the JSON string below
json = "{}"