rahix/openflexure-microscope-server
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Fork with FAFO patches
2068 commits 1 branch 0 tags 24 MiB
Find a file
Joel Collins 3cfbb40655 Removed pointless GPU preview log
2020-10-28 15:40:51 +00:00
.gitlab/issue_templates Added basic issue templates 2020-05-22 10:35:21 +01:00
docs Code formatting 2020-10-13 15:02:19 +01:00
openflexure_microscope Removed pointless GPU preview log 2020-10-28 15:40:51 +00:00
tests Code formatting 2020-10-13 15:02:19 +01:00
.gitattributes Revert "Remove CI file from frame branch" 2020-05-18 09:54:18 +00:00
.gitignore Added .env*/ and pip-wheel-metadata/ 2019-11-01 16:07:01 +00:00
.gitlab-ci.yml Never allow pylint failure 2020-10-22 16:00:35 +01:00
.tarignore Keep tarignore, ignore .gitlab 2020-09-18 13:43:35 +00:00
CONTRIBUTING.md Update CONTRIBUTING.md 2019-05-24 10:47:57 +00:00
Dockerfile Added Dockerfile 2020-09-18 15:06:22 +00:00
LICENSE Add LICENSE 2019-02-19 14:51:33 +00:00
poetry.lock 2.6.4 2020-10-26 15:11:33 +00:00
pyproject.toml Fixed node_modules exclusion from Black 2020-10-27 14:12:41 +00:00
README.md Update README.md 2020-09-29 12:16:34 +00: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.

Developer installation

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

Node installation

  • Note, building the static interface will require a valid Node.js installation
  • To build on a Raspberry Pi:
    • curl -sL https://deb.nodesource.com/setup_14.x | sudo bash -
    • sudo apt install nodejs

Distributing

  • mkdir -p dist
  • tar -c --exclude-vcs --exclude-from .tarignore -vzf dist/openflexure-microscope-server.tar.gz .

Docker

We don't use docker to distribute the server application due to the number of system-level permissions it would need, and the fact that docker mounts break the autostorage extension. If you really want to use docker though, after building the image on your pi you need to start the container with the following flags:

  • docker run --privileged -v /opt/vc:/opt/vc --env LD_LIBRARY_PATH=/opt/vc/lib --device /dev/vchiq --publish 5000:5000

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.