Skip to content

PaNOSC-ViNYL/instrumentDataBaseAPI

Repository files navigation

Introduction

Documentation Status https://github.com/PaNOSC-ViNYL/instrumentDataBaseAPI/actions/workflows/doc.yml/badge.svg?event=page_build

This library provides a simple python API to the instrument database of neutron and X-ray facilities for users to be used in Jupyter notebooks with the tools developed by the PANOSC project.

The user is able to retrieve the instrument description from the centrally maintained repository on Github as well as any suitable repository.

This API is meant as a READ ONLY access to the instrument database. Modifications to the instrument description can either be performed to the instruments after loading a specific instrument or to the python description script by advanced users.

The instrument database is then copied locally in a temporary directory. It is highly suggested to define which is the local folder PATH.

This API is not part of the instrument database repository, because users can use it to access any kind of instrument database structured as https://github.com/PaNOSC-ViNYL/instrument_database.