Skip to main content

OMERO scripts

Project description

https://travis-ci.org/ome/omero-scripts.svg https://badge.fury.io/py/omero-scripts.svg

OMERO Core Scripts

This directory contains OMERO scripts which use the OMERO.scripts API. All scripts (e.g. *.py) present in the directory will be automatically distributed with all binary builds. Which file-endings will be detected and how they will be launched are both configured centrally in the server. .py, .jy", and ``.m (MATLAB) files should all be detected by default starting with OMERO 5.

Categories

Scripts are separated into several categories, one per directory.

In the directory | should be scripts which … |
—————- | ——————— |
analysis_scripts | crunch images to produce numerical results and similar tasks |
export_scripts | take one or more images as an input, and produce a representation for exchange|
figure_scripts | take one or more images as an input, and produce a summary representation |
hcs_scripts | work with screens/plates/wells rather than just images |
import_scripts | are run on images after import for extra processing |
processing_scripts | create new images from existing images or other data |
setup_scripts | are executed once, often by administrators, to configure OMERO itself |
util_scripts | perform other miscellaneous tasks like cleaning up or optimizing OMERO itself |

Scripts which would like to rely on other scripts can use:

import omero.<sub_dir>.<script_name>

For this to work, the official script in question must be properly importable, i.e.:

def run():

client = omero.scripts.client(…)

if __name__ == “__main__”:

run()

OMERO User Scripts

If you would like to provide your own scripts for others to install into their OMERO installations, please see http://openmicroscopy.org/info/scripts

Testing

Integration tests under test/ require an OMERO server with scripts installed. The tests are run by Travis for open PRs using omero-test-infra to deploy OMERO via Docker containers.

To run tests locally:

# All tests $ python setup.py test

# Single test in a single file $ python setup.py test -t test/integration/test_util_scripts.py -k test_dataset_to_plate

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

omero-scripts-5.6.1.dev1.tar.gz (76.7 kB view details)

Uploaded Source

File details

Details for the file omero-scripts-5.6.1.dev1.tar.gz.

File metadata

  • Download URL: omero-scripts-5.6.1.dev1.tar.gz
  • Upload date:
  • Size: 76.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.2.0 pkginfo/1.5.0.1 requests/2.24.0 setuptools/49.2.0 requests-toolbelt/0.9.1 tqdm/4.47.0 CPython/3.6.7

File hashes

Hashes for omero-scripts-5.6.1.dev1.tar.gz
Algorithm Hash digest
SHA256 e756d55f34c1f08e393947653dfa01d93e804a9dd1a24363ed8f4019cbbc68a1
MD5 d1554a64b685905c9e4c77f0a374512d
BLAKE2b-256 d85b070f8e7d23ce4e0af0dc24b126cb15f6cfd481a7b19bfff31ede2d88902b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page