Skip to content

add basic acquire server usage doc#1447

Open
barentine wants to merge 1 commit into
python-microscopy:masterfrom
barentine:webuidoc
Open

add basic acquire server usage doc#1447
barentine wants to merge 1 commit into
python-microscopy:masterfrom
barentine:webuidoc

Conversation

@barentine
Copy link
Copy Markdown
Member

Addresses issue potential PYME user interested in different UI than our wx-based UI. They are interested in software development, so I wanted to show them and others what we already have in the space of an alternative UI.

Is this a bugfix or an enhancement?
enhancement
Proposed changes:

  • add page on acquire server / web ui
  • link from PYMEAcquire basic usage page

Checklist:
The below is a list of things what will be considered when reviewing PRs. It is not prescriptive, and does not
imply that PRs which touch any of these will be rejected but gives a rough indication of where there is a potential
for hangups (i.e. factors which could turn a 5 min review into a half hour or longer and shunt it to the bottom
of the TODO list).

  • Does the PR avoid variable renaming in existing code, whitespace changes, and other forms of tidying? [There is a place for code tidying, but it makes reviewing
    much simpler if this is kept separate from functional changes. The auto-formatting performed by some editors is particulaly egregious and can lead to files with thousands
    of non-functional changes with a few functional changes scattered amoungst them]

If an enhancement (or non-trivial bugfix):

  • Has this been discussed in advance (feature request, PR proposal, email, or direct conversation)?
  • Does this change how users interact with the software? How will these changes be communicated?
  • Does this maintain backwards compatibility with old data?
  • Does this change the required dependencies?
  • Are there any other side effects of the change?

@David-Baddeley
Copy link
Copy Markdown
Contributor

I realise this is dear to your heart, but I wonder if we are jumping the gun a bit here (particularly with linking the web UI from the main PYMEAcquire docs). The Web UI as it stands is not really functional, and is likely to be a source of immense frustration for anyone who tries to use it.

I'll have a look to see how we can incorporate it - maybe, e.g. under a Future directions heading rather than the current Changing the UI heading.

@barentine
Copy link
Copy Markdown
Member Author

Sounds good, @David-Baddeley . All fair points. Future directions would make more sense, probably, particularly for folks excited by it who want to get involved

@David-Baddeley
Copy link
Copy Markdown
Contributor

also just a note that once #1461 is merged, PYMEAcquire -s will launch the PYMEAcquire normally, but with the server running at the same time. PYMEAcquire -s -b will launch the browser interface as well.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants