Skip to content

Doc: short cluster intro / cluster of one call-out in cluster_install #1289

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
barentine wants to merge 5 commits into from
Closed

Doc: short cluster intro / cluster of one call-out in cluster_install #1289

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3a88ef6
add quick intro
barentine Oct 3, 2022
11614af
mention clusterofone is already installed in clusterinstall doc
barentine Oct 3, 2022
1596c3d
remove low level api heading until we add it
barentine Oct 3, 2022
46697b6
revert
barentine Oct 3, 2022
20c9fac
remove outdated django install note
barentine Oct 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions docs/cluster/PYMECluster.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
The PYME Storage and compute cluster architecture
*************************************************

The PYME cluster architecture facilitates parallelized data analysis and
distributed data storage. It can be deployed in a modular approach, just for
parallel (distributed) analysis, or just for distributed data storage, and can
be used on a single computer using internal ports, or on its own network
interface to facilitate the use of multiple computers.

.. toctree::
:maxdepth: 1
Expand Down
27 changes: 25 additions & 2 deletions docs/cluster/cluster_install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,31 @@ Setting up PYME cluster hardware and software

.. _clusterinstall:

This document details the steps to set up a linux cluster for data analysis. In this document we focus on high-thoughput
analysis of full data rate (800MB/s) sCMOS data, although the same infrastructure can be used for conventional PALM/STORM
Single Computer (PYMEClusterOfOne)
==================================

The PYME cluster architecture is included in all PYME installations, and can be
run on a single computer for local, parallel analysis by opening the
`PYMEClusterOfOne` shortcut or start menu item, or by typing
.. code-block:: bash

PYMEClusterOfOne

in a terminal window (OSX, Linux) or *"Anaconda prompt"* (Windows) [#anacondaprompt]_ .
On Windows you may be prompted to allow python through the firewall, which you
should accept.

A browser page for monitoring active analysis tasks will be
opened. Note that a more complete browser-based user interface for the cluster
can be opened by modifying the same terminal command with the flag `--clusterUI`.
This improved interface allows initiation of analysis rather than just monitoring.

Multi-Computer Cluster
======================

The remainder of this document details the steps to set up a linux cluster for
data analysis. We will focus on high-thoughput analysis of full data rate
(800MB/s) sCMOS data, although the same infrastructure can be used for conventional PALM/STORM
experiments, see :ref:`localization analysis<_localization_analysis>` docs for key differences.

Recommended Hardware configuration
Expand Down