[Planning] Rebuilding Spectral Workbench capture and analysis interface (Outreachy)

[Georjane]

Hi there 👋🏽 This issue is a draft of project tasks. I plan on contributing to this and much more as time unfolds!

My Outreachy Proposal

Project Tasks

• Locally install and run code by following installation steps on spectral-workbench Readme
• Run tests and make sure everything is working fine #803
• Set up the JavaScript library following installation steps in the Readme #804
• Print out and cut the papercraft spectrometer (using a spare blank DVD-R) from here following Papercraft Spectrometer Intro Kit #805
• Reconnect broken routes
• Copy the correct link from the contribution page and insert it on the Recent Spectra Section for the contributor's name that currently has a broken link #809
• Find broken routes on the spectral workbench app and add them to a list here #833
• Fix overlapping text on the spectral workbench #808
• Protect routes with functional tests #834
• Port Geocode tool back into new Capture interface, next steps #848
• Reproduce detection of fluorescent lights from legacy capture interface into new capture interface (this then offers to calibrate, with an alert along the top!) #885
• Debug Safari compatibility and confirm iOS compatibility, iOS Safari video freezes spectral-workbench.js#266
• Develop setting to increase capture image resolution above currently fixed 640px - Develop setting to increase capture image resolution above currently fixed 640px #893
• Reconnect and refine “Compare spectra” and “Find Similar” functions within the Rails app
• Prototype a “reduce noise with time averaging” function within the JS library
• Further develop a stand-alone program from viewer and capture modules without Rails app (for example, ability to drag + drop and view a graph for saved JSON data or image)

Useful Resources

• Spectral Workbench goals
• PLANNING ISSUE : Spectral Workbench Capture
• [Planning] - spectralworkbench.js / rails integration
• GSoC 2021 Proposal: spectral-workbench.js JS/Rails integration
• Testing your work with Unstable
• Spectral Workbench Operations

[welcome]

Thanks for opening your first issue! This space is protected by our Code of Conduct - and we're here to help.
Please follow the issue template to help us help you 👍🎉😄
If you have screenshots or a gif to share demonstrating the issue, that's really helpful! 📸
Do join our Gitter channel for some brainstorming discussions.

[Georjane]

Hi, @jywarren @Tlazypanda @TildaDares this is a draft of my task. I will be editing it as time goes by. With a better understanding of the codebase too, I will be able to modularize each of the tasks.
I would love to hear your point of view on this first draft.
For week 1, I want to complete onboarding which entails reading necessary materials on Public Lab like the google docs Jeff shared during the meeting, setting up the codebase, and familiarizing myself with the tests.

[jywarren]

Thank you and this looks like a great start! Will you be getting the JavaScript lib running separately first before trying it within the rails app, or the other way around? Either would work!

…

On Tue, Dec 7, 2021, 9:50 AM Witah Georjane ***@***.***> wrote: Hi, @jywarren <https://github.com/jywarren> @Tlazypanda <https://github.com/Tlazypanda> @TildaDares <https://github.com/TildaDares> this is a draft of my task. I will be editing it as time goes by. I would love to hear your point of view on this first draft. For week 1, I want to complete onboarding which entails reading necessary materials on Public Lab like the google docs Jeff shared during the meeting, setting up the codebase, and familiarizing myself with the tests. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#801 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAF6J2PCENTIS4TBOJYHQDUPYNLNANCNFSM5JRN3ZVQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

[Georjane]

Thank you and this looks like a great start! Will you be getting the JavaScript lib running separately first before trying it within the rails app, or the other way around? Either would work!
…
On Tue, Dec 7, 2021, 9:50 AM Witah Georjane @.***> wrote: Hi, @jywarren https://github.com/jywarren @Tlazypanda https://github.com/Tlazypanda @TildaDares https://github.com/TildaDares this is a draft of my task. I will be editing it as time goes by. I would love to hear your point of view on this first draft. For week 1, I want to complete onboarding which entails reading necessary materials on Public Lab like the google docs Jeff shared during the meeting, setting up the codebase, and familiarizing myself with the tests. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#801 (comment)>, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAF6J2PCENTIS4TBOJYHQDUPYNLNANCNFSM5JRN3ZVQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

I would love to get the js library running separately first. Let me add that as a task for my onboarding too. Thank you 💯

[TildaDares]

Great job @Georjane! Your first draft looks good🚀

[jywarren]

Ah, also! I wanted to say that for testing yours, we can send you a papercraft spectrometer that's designed to work with this software! If you want to email me your mailing address. It's also available to print out and cut out yourself (using a spare blank DVD-R) from https://publiclab.org/paper

We can try mailing you one that uses a webcam too - but it is a package, instead of an envelope, so it could take a while to arrive.

[Georjane]

Ah, also! I wanted to say that for testing yours, we can send you a papercraft spectrometer that's designed to work with this software! If you want to email me your mailing address. It's also available to print out and cut out yourself (using a spare blank DVD-R) from https://publiclab.org/paper

We can try mailing you one that uses a webcam too - but it is a package, instead of an envelope, so it could take a while to arrive.

I can print it out and cut it myself. It would be fun experiencing the DIY practical part of it. Thanks Jeff. I will add it to my tasks and keep you updated on my progress with it.

[jywarren]

OK, just be sure to print it onto quite thick paper if possible, and I believe there is a reverse side that prints all black -- but you can also do that yourself with some black paint if it's easier on the printer. Enjoy!

…

On Wed, Dec 8, 2021 at 12:10 PM Witah Georjane ***@***.***> wrote: Ah, also! I wanted to say that for testing yours, we can send you a papercraft spectrometer that's designed to work with this software! If you want to email me your mailing address. It's also available to print out and cut out yourself (using a spare blank DVD-R) from https://publiclab.org/paper We can try mailing you one that uses a webcam too - but it is a package, instead of an envelope, so it could take a while to arrive. I can print it out and cut it myself. It would be fun experiencing the DIY practical part of it. Thanks Jeff. I will add it to my tasks and keep you updated on my progress with it. — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#801 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAAF6JY4J5FXW5XUPJON7VTUP6GRPANCNFSM5JRN3ZVQ> . Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.

[Tlazypanda]

Hey @Georjane This looks amazing!! 🎉 I love the way the list is ordered to allow you to work in a gradual manner as you get deeper into the codebase. All the best Jane ❤️

Adding some issues here for your reference -

• Reconnect broken routes Additional routes need to be repaired #737
• Protect routes with functional tests Add tests for routes to protect them #736 example issue - Add routes test for sets/embed2/:id #741

As mentioned by @jywarren you can just go through the blame feature and find the recent added routes and create tests for them

[Georjane]

Okay, @Tlazypanda, Thank you very much, It's so kind of you to share the above links that will be very resourceful to me. Thank you

[cesswairimu]

Hi @Georjane, on the task you needed clarification on, I have created a discussion issue here #893 and I will add the info I can get and we can discuss there. Thanks