rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Fork with FAFO patches
1003 commits 1 branch 0 tags 24 MiB
Find a file
Joel Collins 34b1c66cdf Updated build instructions
2020-05-15 17:15:01 +01:00
docs Updated to new Action tasks 2020-05-12 11:29:53 +01:00
openflexure_microscope Added eV build script 2020-05-15 15:24:30 +01:00
tests Implemented root API v2 routes 2019-11-14 16:33:00 +00:00
.gitattributes Removed old static files 2020-05-15 14:25:42 +01:00
.gitignore Added .env*/ and pip-wheel-metadata/ 2019-11-01 16:07:01 +00:00
.gitmodules Set up eV submodule 2020-05-15 14:57:03 +01:00
CONTRIBUTING.md Update CONTRIBUTING.md 2019-05-24 10:47:57 +00:00
LICENSE Add LICENSE 2019-02-19 14:51:33 +00:00
poetry.lock Lock picamera dependency to wheel 2020-05-15 17:14:49 +01:00
pyproject.toml Lock picamera dependency to wheel 2020-05-15 17:14:49 +01:00
README.md Updated build instructions 2020-05-15 17:15:01 +01:00
readthedocs.yaml Updated RTD to Py37 2019-09-14 15:58:02 +01:00

README.md

OpenFlexure Microscope Software

Quickstart

A general user-guide on setting up your microscope can be found here on our website. This includes basic installation instructions suitable for most users.

Full developer documentation can be found on ReadTheDocs. This includes installing the server in a mode better suited for active development.

Installation

  • git clone --recurse-submodules https://gitlab.com/openflexure/openflexure-microscope-server.git
  • poetry install
  • poetry run build_static

Distributing

  • poetry run build
    • Dist files will then be in /dist

Build-system

As of 1.0.0b0, we're using Poetry to manage dependencies, build, and distribute the package. All package information and dependencies are found in pyproject.toml, in line with PEP 518. If you're developing this package, make use of poetry.lock to ensure you're using the latest locked dependency list.

Microscope plugins

The Microscope module, and Flask app, both support plugins for extending lower-level functionality not well suited to web API calls. This plugin system is still in fairly early development, and is not yet properly documented. The current documentation can be found here.

Running tests through the PTVSD remote debugger (port 3000)

  • From the openflexure-microscope-software directory, run python3 -m ptvsd --host 0.0.0.0 --port 3000 --wait tests/test_camera.py

Credits

Piexif

The microscope server includes a forked copy of hMatoba's Piexif, licensed under the MIT License.

Video streaming

Based on supporting code for the article video streaming with Flask and its follow-up Flask Video Streaming Revisited.