Commit 59b31780 authored by Andrew Cohen's avatar Andrew Cohen

readme

parent 94bc8a9a
lever.js readme
<h1> welcome to lever.js </h1>
i'm glad you're here.
i'm glad you're here. leverjs is a great tool for live cell & organelle image analysis. the goal is for the software to be a resource to the community (that's you). i'm grateful for help/feedback, and i support any efforts to make the tools more broadly useful.
<h1> KNOWN ISSUES </h1>
this is a preview release. this is not licensed for public viewing or use. this is for collaborators with Andy Cohen's (https://bioimage.coe.drexel.edu) group to have a chance to try out the new software, test features and provide feedback.
this is a preview release. this is for collaborators with Andy Cohen's (https://bioimage.coe.drexel.edu) group to have a chance to try out the new software, test features and provide feedback. a manuscript describing this work is being planned now. once that manuscript is published, the program will be released free and open source...(gpl? mit? bsd? suggestions welcome...) until then, the software is not licensed for redistribution, and is not intended for public use.
the main issue is that the .LEVER file format will change significantly at least once before general release. i will provide an update program, but because the .LEVER files are "authored" by the user, you will want to backup your files and apply the update at a time of your choosing. if that sounds too complicated, you may want to wait for a more mature release of the program.
other issues are logged in the gitlab system. please feel free to create an account and log issues as you find them.
generally, the ui needs work. all of the features i think should be in the program are avaialable, but they are not always where you would expect them to be.the view tab transfer function is a fantastic example of ui gone wrong -- the first person who can demonstrate a mock up of the right way to do this will win a hot or cold beverage of their choice!
please log any issues or suggestions via the gitlab server. you can create an account, and then open issues for suggestions/bugs/questions.
<h1>INSTALLING FROM PREBUILT</h1>
open this link: <https://leverjs.net/download/>. click on the latest .exe file.
(note - sorry i don't have a code signing cert yet). that is really my code above,
open this link: <https://leverjs.net/download/>. click on the latest .exe file. (note - sorry i don't have a code signing cert yet). that is really my code above,
on my server, verified by the https. so, tell your browser to just install it.
you can download sample image data from the link as well, as well as a zip file of a recent git archive (better to see "INSTALLING FROM SOURCE" below)
......@@ -80,5 +74,11 @@ client side javascript.
1. to debug matlab process, edit package.json and set 'noLaunchMatlab' to true. start the image window renderer program, pick your algorithms and select reseg all (or next). then start matlab. run matlabpollDB('\path\to\leverFile.LEVER'). Or, just run matlabPollDB and it usually finds the right LEVER file automagically (from lever.state tidbit left by CmdLoop.js).
<h2>scripting and image capture for visualization</h2>
see the scripting tab in the electron (stand-alone) image window for more details...
<h2>security</h2>
security is designed into leverjs at every level, from the firewall, to the nginx reverse proxy, to auth0 (link) user api tokens, to programmatic access tokens using private/public key signing. more details to follow soon...
in the interim, to access the api functionality, you can use auth0 for use authentication (details TBD) or you can generate your own keys for programmatic authentication (run node.exe leverjs\keyGen.js, see matlab\+Client for examples).
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment