Skip to content
This repository has been archived by the owner on Apr 8, 2020. It is now read-only.

emlynjdavies/PySilCam

Repository files navigation

PySilCam

Docker build and test

A Python interface to the SilCam.

Features

  • Acqusition of images from SilCam.
  • Real-time processing of SilCam images, particle statistics.
  • Processing images from disk (batch or real-time).

Requirements

Installing

Install Anaconda: https://www.anaconda.com/download/ Python 3.6 version

Anaconda Prompt may be used for the following

Create a virtual environment using the environment.yml (will create an environment called silcam)

    conda env create -f environment.yml

to update:

    conda env update --file environment.yml --prune

to activate:

    conda activate silcam

Test that it works with

    python setup.py develop
    python setup.py test

Build the documentation

    python setup.py build_sphinx

See the wiki for more details on running PySilCam.

Docker

The Dockerfile will spin up an environment where Anaconda Python 3.5 is installed, and the source code folder (this folder) is mapped to /silcam. The first time you must run this command to build a container (or any time the Dockerfile changes)

docker-compose build

Note: you might need sudo here.

To run the tests inside the Docker environment:

docker-compose up

To get an interactive shell session with the PySilcam Docker environment run:

docker-compose run --rm --entrypoint /bin/bash silcam

Note: make sure to remove any .pyc files generated on the host system, as these can cause problems inside the Docker environment.

If you want to mount a local folder inside the docker environment, use -v [local path:docker mount point]:

docker-compose run -v /mnt/ARRAY/:/mnt/ARRAY/ --rm --entrypoint /bin/bash silcam

License

PySilCam is licensed under the BSD3 license. See LICENSE