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.11.tar.gz (9.6 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.11-py2.py3-none-any.whl (10.2 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for mmpycorex-0.3.11.tar.gz
Algorithm Hash digest
SHA256 f91a4e22e80e2c44f8bd19d788ee6fbcd523df9f1e6b803909b21f2391b5feea
MD5 979eb7e81f6c8701740d1afd5b9c364d
BLAKE2b-256 8e612f8a7058bd257cbdb7a2966f38aea17e832e541e051949257ca55acce0b0

See more details on using hashes here.

Provenance

The following attestation bundles were made for mmpycorex-0.3.11.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.11-py2.py3-none-any.whl.

File metadata

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

File hashes

Hashes for mmpycorex-0.3.11-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 abbf8b2a82e1f4a03b508b7ac84757058942f800c2cd36584876d3e8e6a64602
MD5 66e24ead3dce41317212fb31bb58bd02
BLAKE2b-256 6c0e67029644ea1de03e2c14da2d3cc0151030efa45529fd3f24a4b22086f7d6

See more details on using hashes here.

Provenance

The following attestation bundles were made for mmpycorex-0.3.11-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