Macromolecular crystallography group (CPS)
Repositories
10
 Projects Packages Code Members
1

aareDB (0.119.0)

Published 2026-10-05 23:40:23 +02:00 by leonarski_f

Installation

pip install --index-url https://gitea.psi.ch/api/packages/mx/pypi/simple/ --extra-index-url https://pypi.org/simple aareDB

About this package

aareDB

aareDB

Dispatcher service for job and tell management

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.119.0
  • Package version: 0.119.0
  • Generator version: 7.20.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import aareDB

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import aareDB

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import aareDB
from aareDB.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = aareDB.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with aareDB.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = aareDB.AnnotationsApi(api_client)
    since = 'since_example' # str | ISO date or datetime to filter images from this timestamp onward (optional)
    x_shared_password = 'x_shared_password_example' # str |  (optional)

    try:
        # Next Image
        api_response = api_instance.next_image_protected_router_annotations_raw_next_get(since=since, x_shared_password=x_shared_password)
        print("The response of AnnotationsApi->next_image_protected_router_annotations_raw_next_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AnnotationsApi->next_image_protected_router_annotations_raw_next_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AnnotationsApi next_image_protected_router_annotations_raw_next_get GET /protected_router/annotations/raw_next Next Image
AnnotationsApi save_annotation_protected_router_annotations_image_id_post POST /protected_router/annotations/{image_id} Save Annotation
AnnotationsApi skip_image_protected_router_annotations_image_id_skip_post POST /protected_router/annotations/{image_id}/skip Skip Image
AnnotationsApi sync_local_annotations GET /protected_router/annotations/sync/local Sync Local From Db
ClipRunnerApi update_clip_job_status POST /protected_router/clip_runner/jobs/update_status Update the status of a clip job
FluorescenceApi ingest_fluorescence_scan POST /protected_router/fluorescence/ingest Ingest Fluorescence Scan
GridscanRunnerApi ingest_completed_grid POST /protected_router/gridscan_runner/ingest Ingest completed raster grid and auto-link experiment run and image
ProcessingsRunnerApi create_merged_result POST /protected_router/processing_runner/create_merged_result Submit a new merged processing result
ProcessingsRunnerApi create_result POST /protected_router/processing_runner/processing-results Submit new processing result
ProcessingsRunnerApi create_sample_merge POST /protected_router/processing_runner/create_sample_merge Create a new merge sample entry
ProcessingsRunnerApi download_processing_file GET /protected_router/processing_runner/processing-files/{file_id} Download a processing file
ProcessingsRunnerApi download_sample_model GET /protected_router/processing_runner/samples/{sample_id}/model Download the registered PDB model for a sample
ProcessingsRunnerApi list_result_files GET /protected_router/processing_runner/processing-results/{result_id}/files List all files for a result
ProcessingsRunnerApi set_result_mr PATCH /protected_router/processing_runner/processing-results/{result_id}/mr Attach the MR/dimple outcome to an existing processing result
ProcessingsRunnerApi update_merge_status POST /protected_router/processing_runner/jobs_merge/update_status Update the status of a merge job
ProcessingsRunnerApi update_result PUT /protected_router/processing_runner/processing-results/{result_id} Update an existing processing result
ProcessingsRunnerApi update_status POST /protected_router/processing_runner/jobs/update_status Update the status of a job
ProcessingsRunnerApi upload_result_files POST /protected_router/processing_runner/processing-results/{result_id}/upload-files Upload files to an existing processing result
ReportRunnerApi claim_report_job_protected_router_report_runner_claim_post POST /protected_router/report_runner/claim Claim Report Job
ReportRunnerApi complete_report_job_protected_router_report_runner_job_id_complete_post POST /protected_router/report_runner/{job_id}/complete Complete Report Job
ReportRunnerApi fail_report_job_protected_router_report_runner_job_id_fail_post POST /protected_router/report_runner/{job_id}/fail Fail Report Job
ReportRunnerApi redeem_facts_protected_router_report_runner_facts_post POST /protected_router/report_runner/facts Redeem Facts
SamplesRunnerApi add_evaluation_tag_protected_router_sample_runner_run_id_add_tag_put PUT /protected_router/sample_runner/{run_id}/add_tag Add Evaluation Tag
SamplesRunnerApi add_evaluation_tag_to_latest_run_protected_router_sample_runner_sample_sample_id_add_tag_to_latest_run_put PUT /protected_router/sample_runner/sample/{sample_id}/add_tag_to_latest_run Add Evaluation Tag To Latest Run
SamplesRunnerApi create_experiment_parameters_for_sample POST /protected_router/sample_runner/samples/{sample_id}/experiment_parameters Create experiment parameters for a sample
SamplesRunnerApi create_sample_event POST /protected_router/sample_runner/samples/{sample_id}/events Create and add an event to a sample
SamplesRunnerApi get_samples_by_beamtime GET /protected_router/sample_runner/by-beamtime/{beamtime_id} List all samples for a given beamtime
SamplesRunnerApi insert_sample POST /protected_router/sample_runner/insert_sample Insert a manually mounted sample.
SamplesRunnerApi set_evaluation_smiley_protected_router_sample_runner_run_id_set_smiley_put PUT /protected_router/sample_runner/{run_id}/set_smiley Set Evaluation Smiley
SamplesRunnerApi set_evaluation_smiley_to_latest_run_protected_router_sample_runner_sample_sample_id_set_smiley_to_latest_run_put PUT /protected_router/sample_runner/sample/{sample_id}/set_smiley_to_latest_run Set Evaluation Smiley To Latest Run
SamplesRunnerApi upload_sample_image POST /protected_router/sample_runner/{sample_id}/upload-images Upload an image for a sample (linked to its most recent event)
ScanRunnerApi ingest_completed_scan POST /protected_router/scan_runner/ingest Ingest completed rotation scan and auto-link experiment run
TellsRunnerApi get_pucks_with_tell_position GET /protected_router/tell_runner/with-tell-position List Pucks With Current Tell Position
TellsRunnerApi set_tell_positions PUT /protected_router/tell_runner/set-tell-positions Set Tell Positions for Pucks
TrainingPoolApi batch_items_protected_router_training_pool_batches_batch_id_items_get GET /protected_router/training_pool/batches/{batch_id}/items Batch Items
TrainingPoolApi claim_inference_job_protected_router_training_pool_inference_claim_post POST /protected_router/training_pool/inference/claim Claim Inference Job
TrainingPoolApi cut_recipe_protected_router_training_pool_recipes_recipe_id_cut_post POST /protected_router/training_pool/recipes/{recipe_id}/cut Cut Recipe
TrainingPoolApi export_labels_protected_router_training_pool_labels_get GET /protected_router/training_pool/labels Export Labels
TrainingPoolApi get_pool_image_detail_protected_router_training_pool_tpid_get GET /protected_router/training_pool/{tpid} Get Pool Image Detail
TrainingPoolApi get_pool_image_protected_router_training_pool_tpid_image_get GET /protected_router/training_pool/{tpid}/image Get Pool Image
TrainingPoolApi inference_job_image_protected_router_training_pool_inference_job_id_image_get GET /protected_router/training_pool/inference/{job_id}/image Inference Job Image
TrainingPoolApi inference_job_result_protected_router_training_pool_inference_job_id_result_post POST /protected_router/training_pool/inference/{job_id}/result Inference Job Result
TrainingPoolApi inference_queue_protected_router_training_pool_inference_queue_get GET /protected_router/training_pool/inference/queue Inference Queue
TrainingPoolApi list_batches_protected_router_training_pool_batches_get GET /protected_router/training_pool/batches List Batches
TrainingPoolApi list_candidates_protected_router_training_pool_candidates_get GET /protected_router/training_pool/candidates List Candidates
TrainingPoolApi list_recipes_protected_router_training_pool_recipes_get GET /protected_router/training_pool/recipes List Recipes
TrainingPoolApi pool_image_raster_protected_router_training_pool_tpid_raster_get GET /protected_router/training_pool/{tpid}/raster Pool Image Raster
TrainingPoolApi pool_stats_protected_router_training_pool_stats_get GET /protected_router/training_pool/stats Pool Stats
TrainingPoolApi record_decision_protected_router_training_pool_tpid_decision_post POST /protected_router/training_pool/{tpid}/decision Record Decision
TrainingPoolApi refill_due_protected_router_training_pool_refill_due_get GET /protected_router/training_pool/refill/due Refill Due
TrainingPoolApi review_queue_protected_router_training_pool_review_queue_get GET /protected_router/training_pool/review_queue Review Queue
TrainingPoolApi upsert_proposal_protected_router_training_pool_tpid_proposal_put PUT /protected_router/training_pool/{tpid}/proposal Upsert Proposal

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author

Requirements

Requires Python: >=3.9
Details
PyPI
2026-10-05 23:40:23 +02:00
49
OpenAPI Generator community
389 KiB
Assets (2)
aaredb-0.119.0-py3-none-any.whl 255 KiB
aaredb-0.119.0.tar.gz 133 KiB
Versions (189) View all
0.125.1 2026-10-28
0.125.0 2026-10-27
0.124.8 2026-10-16
0.124.7 2026-10-16
0.124.6 2026-10-16