Skip to main content

Python package for unified MMCore access through pymmcore or ZMQ-MMCoreJ + associated utilities

Project description

License PyPI

mmpycorex

This package contains modules for downloading and installing MM through python, and for accessing the Java core of a running micro-manager instance, creating a headless java core object for access through python, or creating and instance of the python wrapper of the core (pymmcore)

Installation

pip install mmpycorex

Programatically installing Micro-Manager

  • Python utility functions for downloading and installing Micro-Manager
from mmpycorex import download_and_install_mm, find_existing_mm_install

# this automatically installs the latest nightly build
# specify destination="your/custom/path", otherwise it will default to 'C:/Program files/Micro-Manager/'
# on windows or the home directory on mac
installed_path = download_and_install_mm()

Accessing the Java core through python

### Java Core example
from mmpycorex import create_core_instance, terminate_core_instances, get_default_install_location

# If micro-manager is alread running, you can get access to the core directly
# (just make sure the "run server" in the tools options dialog is checked)

# Otherwise you must create an instance of the Core in headless mode
mm_location = get_default_install_location() # 'C:/Program files/Micro-Manager/'
config_file = 'MMConfig_demo.cfg'
create_core_instance(mm_location, config_file, python_backend=False) # Create a remote MMCoreJ object

# Now that a core is running (either through the MM App or headless mode), create an object to access it
core = Core()

#### use the core

terminate_core_instances() 

Accessing the python core (pymmcore)

### pymmcore example
from mmpycorex import create_core_instance, terminate_core_instances

# Otherwise you must create an instance of the Core in headless mode
mm_location = get_default_install_location() # 'C:/Program files/Micro-Manager/'
config_file = 'MMConfig_demo.cfg'
create_core_instance(mm_location, config_file, python_backend=True) # Create pymmcore instance

# Now that a core is running (either through the MM App or headless mode), create an object to access it
core = Core()

#### use the core

terminate_core_instances() 

Install issues on M1 Macs

https://github.com/conda-forge/miniforge/issues/165#issuecomment-860233092

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

mmpycorex-0.3.16.tar.gz (168.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mmpycorex-0.3.16-py2.py3-none-any.whl (10.8 kB view details)

Uploaded Python 2Python 3

File details

Details for the file mmpycorex-0.3.16.tar.gz.

File metadata

  • Download URL: mmpycorex-0.3.16.tar.gz
  • Upload date:
  • Size: 168.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mmpycorex-0.3.16.tar.gz
Algorithm Hash digest
SHA256 d29d7e0b6cdff8c798a972b76c6d646e2fdbc45c9645b0ffdadcfb6be8b10cd1
MD5 ecea92c07569718e52202cdc5d280002
BLAKE2b-256 9ffce68e75e6df43abd12e5ab4c143dbf2cfd0374b7cd2be801618994fe7545f

See more details on using hashes here.

Provenance

The following attestation bundles were made for mmpycorex-0.3.16.tar.gz:

Publisher: publish_pypi.yaml on micro-manager/mmpycorex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file mmpycorex-0.3.16-py2.py3-none-any.whl.

File metadata

  • Download URL: mmpycorex-0.3.16-py2.py3-none-any.whl
  • Upload date:
  • Size: 10.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for mmpycorex-0.3.16-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 b6b2856200c7774052b48175110b4a23cc53620d53c1254df6c9b5cf47bafa49
MD5 3328c1665303552e20d369f606c0dcb4
BLAKE2b-256 d511f2219a36e14c0821ad239b976228e8f53bb7718d03ec9aeb3102a5cdaa8c

See more details on using hashes here.

Provenance

The following attestation bundles were made for mmpycorex-0.3.16-py2.py3-none-any.whl:

Publisher: publish_pypi.yaml on micro-manager/mmpycorex

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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