Documentation

[JuanLM1978]

Hi guys, There is a draft that I started working on over the weekend on my fork.

I still need to clarify some sections but let me know your opinions so far, please.

I tried to use your explanation files to write something. For some of the things, I really dont know how to explain the work yet. I need to sit down and understand eveything that i have not been involved in, which will be good for checking the whole app and spotting issues.

You can send me your comments and i will add it to the documentation if you want me. Or you may prefer to get it written down and add it to the documenation, becuase it is not only a section in the documenatiton but also part of your individual reflective report that we need to submit.

Don't be shy with the explanations for your side. Include images or anything that makes clear the way our software works.

I wanted to add that draft you Anna said you shared the other day but I did not receive anything so sorry for that but I could not update your part.

Please let me know your opinions

Juan

PS: English is not my mother tongue so please modify whatever you think necessary.

[JuanLM1978]

Hi, I have updated and uploaded a new version of the documentation on my fork. I used https://www.draw.io/ to create diagrams, which is a free on-line tool in case you are interested in. Have a look of the documenation, modify whatever you consider necessary and add your bits please.

Juan

[JuanLM1978]

Scipy needs to be added to the table of requirements listing all the module we used for the software

[AnnaDearman]

Hi Juan, Thanks for this. I have taken a copy and am putting it into my own words. Happy to pass this back to you, or to someone else (whoever wants to "oversee" the documentation) to make a final decision on how to word everything (others may have input too?). Anna

[celiaccb]

The software structure diagram needs to be updated, there are two new folders, uploads & downloads and kinase2.db has been replaced by c__sqlite_final_database.db

[AnnaDearman]

I already corrected this in the document I shared with you all by e-mail :)

[celiaccb]

This is what shows on mine?

[AnnaDearman]

I just hit "save" - did it change anything?

[AnnaDearman]

[JuanLM1978]

There is a new data flow picture (and drawio file for edition) in my folder that matches the format of Yutang´s picture. Do you think it is better to integrate the data flow for data analysis and queries in one single figure?

[AnnaDearman]

Personally, I think they're nice as they are.

[celiaccb]

It still shows the same, do the others see changes made to this document?

[JuanLM1978]

Ok, this is a very stupid question (but that´s they way I feel right now my apologies) I have modified and commented things using OneDrive in Documentation v1 that Anna shared with me the other day Do we all have access to that version? Should I share it with the others via OneDrive? and the most stupid thing HOW do I share that via OneDrive? Sorry for that, bear in mind that I am from a generation that grew up without mobile phones, facebook, instagram, tinder... but we were very happy though!!! Feel so useless! hahaha

[AnnaDearman]

Strange timing, I've just shared it with you on Google Drive. As Celia couldn't access it, we put it on Google Drive this morning and I've only just sent it to everyone else.

I didn't notice any changes from anyone except for your additions to my comments, so I hope nothing's been lost!

[East-YutangChen]

I have just got an email from Anna with the documentation file, I can see all the modifications.

[JuanLM1978]

hahahah so GoogleDrive then... hahaha I made the comments and things in OneDrive (not the same, isn´t it?) I will check the document again, no problem

[AnnaDearman]

If you were making changes to the OneDrive version and they were being saved on my machine, your changes should have been kept in the Google Docs version 🤞 because the OneDrive version is what I uploaded to Google Docs, if that makes sense 🙃

[JuanLM1978]

I made the changes this evening so they were not saved. However, dont worry, it should not be a problem. Should I accept the changes you made in the first version that I am happy with? It would be easier for eveyone to read everything in that way

[AnnaDearman]

I think I've got the changes on my computer. I've locked you out of it now though, in an attempt to stop this happening (I did it too late, I apologise). I'll email you the copy I've got with your changes. Would you mind pasting the changes in to the Google docs version?

[JuanLM1978]

dont worry i have a copy of the changes on my computer I am doing that now

[JuanLM1978]

funny thing is that my internet connection is working as slow as my brain

[JuanLM1978]

This is a reminder to myself. I will need to add the final diagram of the database schema when everyone has finished to add their part to the final documentation.