psi-fytotron 0.2

Python API implementation of PSI fytotron API

PSI Fytotron API implementation

• Documentation
  
• Source Code
  

---

Photon System Instruments (PSI) delivers equipment across the globe. Most of their cells are controlled by a fytotron PC, for which they also provide an optional API. To simplify the implementation and sharing of analysis workflows, we created an OpenAPI specification file and use the Openapi Generator to generate this package.

Installation & Usage

Install from PyPI:

pip install psi-fytotron

Build and tested with Python 3.9+
Cross-platform support for Linux, macOS and Windows

Example implementation

Uses a .env file with the following fields:

URL: http://<ip-address/path>:<port>/fyto/rest
TOKEN: <Fytotron API access token>

The environment files have one additional depency: pip install python-dotenv Example code: https://github.com/NPEC-NL/PSI-Fytotron-API/blob/main/example_implementation.py?plain=1#L2-L32

Contributing

We welcome contributions! If you encounter bugs, have feature requests, or want to suggest improvements, please create an issue and provide a clear description.

Setting up a Development Environment

Requires Python 3.9+

1. Create a virtual environment (venv):

   python -m venv .venv
   

2. Activate the venv:
   • On Windows:

     .venv\Scripts\activate
     

   • On macOS/Linux:

     source .venv/bin/activate
     

3. Install the package with build and test dependencies:

   pip install .[build, test]
   

For developers

This repository contains a few workflows, they work as follows:

• build client, is triggered by a commit and builds the python client from the specification file.
• Build docs, triggered by the completion of build client uses mkdocs to create the documentation pages.
• Test fytotron client, triggered by the completion of build client or by a pull request, runs the unittests on the repository.
• release, can be triggered manually to create a release on testpypi or through a release to push to pypi. To install the release from testpypi, the following command can be used: python -m pip install --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple psi-fytotron

Updating the OpenAPI specification file

The API is automatically generated from the OpenAPI specification file with the openapi generator cli. The workflows automatically build the client and copy the files to the right folders.

Documentation

Build with mkdocs-material

Documentation for API Endpoints

All URIs are relative to https://localhost:8000/fyto/rest

Class	Method	HTTP request	Description
FytotronApi	getvar	GET /getvar	Returns the current value of the variable
FytotronApi	info	GET /info	Returns all setpoints and actual values in the database.
FytotronApi	monitor	GET /monitor	Returns the current status of the fytotron
FytotronApi	setvar	POST /setvar	Set the setpoint value

Documentation For Models

• InfoValues
• MonitorValues

Documentation For Authorization

Authentication schemes defined for the API:

ApiKeyAuth

• Type: API key
• API key parameter name: X-Auth-Token
• Location: HTTP header