Public Lab Research note


Draft of Public Lab Image Sequencer User Manual – Comments Welcome!

by MaggPi | June 10, 2019 04:29 | 121 views | 6 comments | #19642 | 121 views | 6 comments | #19642 10 Jun 04:29

Draft of Public Lab Image Sequencer User Manual – Comments Welcome!

Background

Request for comments

  • Seeking comments from Image Sequencer users and developers on User Manual contents, format and scope of effort.
  • Project goal is to develop a single document that helps users understand, access and implement Image Sequencer software for different Public Lab applications.
  • Version 0.1 of the Image Sequencer User Manual is available at: https://github.com/MargaretAN9/GSOC-2019/blob/master/Image%20Sequencer%20User%20Manual%20v3.docx select 'view raw' for Word file download.
  • The first draft of the user manual incorporates information from the Public Lab Image Sequencer github site as well as examples of Image Sequencer image processing modules. Feel free to recommend new sections and make updates!
  • Also request specific information about content outlined ’ in red’ such as maximum image size, processing time and operating system environment.
  • Please make comments to this post or update the document posted on the github site.
  • Goal is to develop version 0.2 by July 1, 2019 and continue to update till Aug 15, 2019.

All comments appreciated and Thank You for helping Public Lab develop better software (and software documentation)!

@warren @gauravano @sagarpreet @aashnaaashna @lit2017001 @Harshith @jainaman224


I did this Help out by offering feedback!


People who did this (0)

None yet. Be the first to post one!


6 Comments

Hi @maggPi, this is looking great! You should chime in at the weekly check-in at https://github.com/publiclab/simple-data-grapher/issues/41 and I'm sure the image-sequencer community will be really excited!

Reply to this comment...


Oh wow - here's the PDF - i had trouble reading the docx file at first!

image-sequencer-manual.pdf

@maggpi have you considered writing this in Markdown and perhaps posting it either as a markdown file in the image-sequencer project, or on the Public Lab wiki?

Is this a question? Click here to post it to the Questions page.

@warren, got this, posted to the github site and will transition to markdown with the next update Yhx


Reply to this comment...


Wow, this manual is really thorough and well explained! I have a minor technical comment:

  • P5 - Tulip picture is referred to as Figure x, Figure X and on the next page Figure Y -> needs consistency. Another option is just to refer to it as "tulip.jpg" or "tulip.png"

  • Is it possible to hyperlink the sections in the table of contents? I know it's easy to do in Microsoft Word if you are making a PDF using header styles and an automatic table of contents, but I've heard it's not easy to do in Mac. Also I'm not sure how that would happen in markdown.

Is this a question? Click here to post it to the Questions page.

We should indeed be able to hyperlink the table of contents. Check out the links in:

Great idea!


Version 0.2 available at

https://github.com/MargaretAN9/GSOC-2019/blob/master/ImageSequencerUserManual.md#input-format-options

Mods include linked TOC and moved to github


Reply to this comment...


Login to comment.

Public Lab is open for anyone and will always be free. By signing up you'll join a diverse group of community researchers and tap into a lot of grassroots expertise.

Sign up