rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Added Key info

Browse source
This commit is contained in:
Joel Collins 2020-12-09 15:51:02 +00:00
parent 06cc2880e7
commit 332fc90083
1 changed files with 18 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -8,6 +8,24 @@ This includes basic installation instructions suitable for most users.
Full developer documentation can be found on [**ReadTheDocs**](https://openflexure-microscope-software.readthedocs.io/). Full developer documentation can be found on [**ReadTheDocs**](https://openflexure-microscope-software.readthedocs.io/).
This includes installing the server in a mode better suited for active development. This includes installing the server in a mode better suited for active development.
## Key info
* Responsible for actually controlling microscope hardware, data management, and creating the API server.
Also now includes the web client, which is served from the server root.
* Server starts on port 5000 by default.
* Runs on [Python-LabThings](https://github.com/labthings/python-labthings/), and so basically all non-microscope functionality is handled by that library.
### Server settings
https://openflexure-microscope-software.readthedocs.io/en/master/config.html
There are 2 important settings files:
* `/var/openflexure/settings/microscope_configuration.json`
* Boot-time microscope configuration. Things like the type of camera connected, the stage board, geometry etc.
*Anything that needs to be loaded once as the server starts, and usually doesn't need to be re-written while the server is running
* `/var/openflexure/settings/microscope_settings.json`
* Every other persistent setting. Camera settings, calibration data, default capture settings, stream resolution etc.
# Developer guidelines # Developer guidelines
## Creating releases ## Creating releases