Adding commands/Making changes in documentation of README file / development docs #719

ArchishmanSengupta · 2021-03-14T18:26:33Z

Currently the README of installation of the `branch: develop` is this:

i propose to add documentation of forking the repo and adding it before Installation MSS guide.

The documentation will then look like 👍🏼

📌 Prerequisites

💻 1. System requirement :

Any system with basic configuration.
Operating System : Any (Windows / Linux / Mac).

💿 2. Software requirement :

Updated browser
python (If not download it here).

⚡ 3. Skill set :

Knowledge of git & github.
python

📌Setting up the local environment

Forking the repository:
1.Fistly you have to make your own copy of project. For that you have to fork the repository. You can find the fork button on the top-right side of the browser window. (Refer image below )[Adding a picture of the forking button]

2.Kindly wait till it gets forked.

3.After that copy will look like /MSS forked from Open-MSS/MSS.

After this i will add the following:

🚩 Clone repository : [Adding a picture]

🚩 Setting up remote : [Adding a picture]

📌 Pushing your changes: [Adding a picture]

📌 Creating a pull request: [Adding a picture]

You can guide me through if i miss anything.

Please Assign me this task. @ReimarBauer @andreas-h @Marilyth @PrayasJ @plant99
Thanks & Regards,
Archie

The text was updated successfully, but these errors were encountered:

joernu76 · 2021-03-19T10:55:39Z

Hi, good idea!

Some comments.

The Readme.md should stay brief and is currently addressing "users" in stead of developers. The documentation you outlined would enhance https://github.com/Open-MSS/MSS/blob/develop/docs/development.rst greatly! As such I propose to add your github/fork/etc. documentation to that rst-file.
I am unsure if we should add figures as these create a larger maintenance overhead. Keep it textual with, perhaps, links to documentation of github or similar.

ArchishmanSengupta · 2021-03-19T19:44:02Z

alright. will keep these things in mind. Actually i am unable to use the IRC Channel. Is there any other way i can keep in touch with you/other maintainers?

joernu76 · 2021-03-20T13:02:25Z

The Slack-System should be usable wherever you have access to a browser? If that doesn't work, the second best option (and a good option anyway) is to keep the discussion contained in this issue.

ArchishmanSengupta · 2021-03-20T13:22:41Z

can you share me the link of the slack channel which will be used during the gsoc 21 period for this project? @joernu76

joernu76 · 2021-03-20T13:59:47Z

@ReimarBauer knows this better, but I believe that we are currently use
https://mss-devel.slack.com/archives/CSL13ATK7
for gsco preparation. There will be a project dedicated channel once we have funding.

ReimarBauer · 2021-03-20T14:13:51Z

Hi @aravindm711 please send a mail to [email protected], see also, first section ;)
https://open-mss.github.io/contributing/

You get an invite link by me.

ArchishmanSengupta · 2021-03-20T15:23:06Z

hey @ReimarBauer I have sent the email to [email protected]. kindly have a look. Thank you

ArchishmanSengupta · 2021-03-20T17:58:15Z

hey @joernu76 after i add the necessary changes mentioned in the issue, will i add the (https://github.com/Open-MSS/MSS/blob/develop/docs/development.rst ) link in the readme?

joernu76 · 2021-03-21T11:15:58Z

Sounds reasonable that we provide links to the built version of our documentation for further reading.
Here
https://mss.readthedocs.io/en/stable/
is the web-server with the built documentation and this
https://open-mss.github.io/
is a new set of pages added by Reimar. @ReimarBauer , what would be the appropriate system at the current point in time...? And is the new set pf pages based on the RST files?

* issue #719 solved * updated development.rst * updated development.rst Co-authored-by: ReimarBauer <[email protected]>

* Allow specification of file for linear defaultstyle (#1028) * Allow specification of file for default * Simplify if condition * Increase coverage (#1020) * Add wms_control tests * Add more mscolab tests * Add mpl_qtwidget coverage * Add mss_pyui coverage * Add transparency, noframe and xml checks * Add more wms tests * Test import with plugins * Add linearview tests * Add more multilayering tests * Revert to old testing.yml * Leave no dangling windows * Remove todo, move ConnectionError to bottom Co-authored-by: ReimarBauer <[email protected]> * Migrate existing thermodynamic functions to metpy functions (#1009) * removed functions from thermolib.py functions to be replaced by metpy were removed * fixed: flake8 * fixed: flake8 * migrated to metpy functions Co-Authored-By: J. Ungermann <[email protected]> * Fixed: flake8 * Fixed: flake8 * Fixed tests * Fixed: flake8 * Fixed: failing tests * Ficed: tests * Units discarded upon returning results Co-Authored-By: J. Ungermann <[email protected]> * `omega_to_w` migrated to metpy Co-authored-by: ReimarBauer <[email protected]> Co-authored-by: J. Ungermann <[email protected]> * updated documentation (#1008) * updated documentation * improved install/update procedure Co-authored-by: Reimar Bauer <[email protected]> * Fixed: #999 (#1010) * .format replaced with f" string * updated copyright year * fixes #1014 (#1015) * Remove Qt imports (#1019) * Fixes #1014 changing http to https (#1017) Co-authored-by: ReimarBauer <[email protected]> * Linear view mscolab bug (#1021) * fixed tableview not opening bug; added test * added raising of mscolab window after closing view * preparation of v4.0.1 (#1023) * preparation of v4.0.1 * updated install instruction Co-authored-by: J. Ungermann <[email protected]> * Fix pyproj 3.1.0 error (#1033) * Minor bug fixes. (#1054) * Return proper unit for eq. potential temperature (degC->K) * Do not assume units of pressure levels for several old plotting styles. * Fix values of geopotential altitude in demodata * issue #719 solved (#729) * issue #719 solved * updated development.rst * updated development.rst Co-authored-by: ReimarBauer <[email protected]> * Select newest init-time and carry over multilayering (#1047) Co-authored-by: J. Ungermann <[email protected]> * Fix some issues with elevation caching and model level dimensions. (#1061) Fix #1066 * Added missing filename key. (#1062) See #1066 Co-authored-by: May <[email protected]> Co-authored-by: ReimarBauer <[email protected]> Co-authored-by: Jatin Jain <[email protected]> Co-authored-by: J. Ungermann <[email protected]> Co-authored-by: open-mss-build <[email protected]> Co-authored-by: Aryan Gupta <[email protected]> Co-authored-by: Aravind Murali <[email protected]> Co-authored-by: J. Ungermann <[email protected]> Co-authored-by: Archishman Sengupta <[email protected]>

…oblems of being played too fast (#1067) * Allow specification of file for linear defaultstyle (#1028) * Allow specification of file for default * Simplify if condition * Increase coverage (#1020) * Add wms_control tests * Add more mscolab tests * Add mpl_qtwidget coverage * Add mss_pyui coverage * Add transparency, noframe and xml checks * Add more wms tests * Test import with plugins * Add linearview tests * Add more multilayering tests * Revert to old testing.yml * Leave no dangling windows * Remove todo, move ConnectionError to bottom Co-authored-by: ReimarBauer <[email protected]> * Migrate existing thermodynamic functions to metpy functions (#1009) * removed functions from thermolib.py functions to be replaced by metpy were removed * fixed: flake8 * fixed: flake8 * migrated to metpy functions Co-Authored-By: J. Ungermann <[email protected]> * Fixed: flake8 * Fixed: flake8 * Fixed tests * Fixed: flake8 * Fixed: failing tests * Ficed: tests * Units discarded upon returning results Co-Authored-By: J. Ungermann <[email protected]> * `omega_to_w` migrated to metpy Co-authored-by: ReimarBauer <[email protected]> Co-authored-by: J. Ungermann <[email protected]> * updated documentation (#1008) * updated documentation * improved install/update procedure Co-authored-by: Reimar Bauer <[email protected]> * Fixed: #999 (#1010) * .format replaced with f" string * updated copyright year * fixes #1014 (#1015) * Remove Qt imports (#1019) * Fixes #1014 changing http to https (#1017) Co-authored-by: ReimarBauer <[email protected]> * Linear view mscolab bug (#1021) * fixed tableview not opening bug; added test * added raising of mscolab window after closing view * preparation of v4.0.1 (#1023) * preparation of v4.0.1 * updated install instruction Co-authored-by: J. Ungermann <[email protected]> * Fix pyproj 3.1.0 error (#1033) * Made a screen recorder and automated tutorial for demonstrating use of waypoints * Renamed tut pictures to just pictures and moved the tutorials.txt to requirements.d * Minor bug fixes. (#1054) * Return proper unit for eq. potential temperature (degC->K) * Do not assume units of pressure levels for several old plotting styles. * Fix values of geopotential altitude in demodata * issue #719 solved (#729) * issue #719 solved * updated development.rst * updated development.rst Co-authored-by: ReimarBauer <[email protected]> * Select newest init-time and carry over multilayering (#1047) Co-authored-by: J. Ungermann <[email protected]> * Fix some issues with elevation caching and model level dimensions. (#1061) Fix #1066 * Added missing filename key. (#1062) See #1066 * Waypoints tutorial completed * Just changed the sleep timings of the code to make it more efficient : tutorial_waypoints.py * Added the updated tutorials.txt in requirements.d Co-authored-by: May <[email protected]> Co-authored-by: ReimarBauer <[email protected]> Co-authored-by: Jatin Jain <[email protected]> Co-authored-by: J. Ungermann <[email protected]> Co-authored-by: open-mss-build <[email protected]> Co-authored-by: Aryan Gupta <[email protected]> Co-authored-by: Aravind Murali <[email protected]> Co-authored-by: J. Ungermann <[email protected]> Co-authored-by: Archishman Sengupta <[email protected]>

commit 3bd614e Merge: c8b662b 094c388 Author: ReimarBauer <[email protected]> Date: Mon Aug 23 16:35:23 2021 +0200 Merge pull request #1170 from risehr/textfiles Added text files for kml, mscolab, wms, and views tutorials. commit 094c388 Author: Hrithik Kumar Verma <[email protected]> Date: Mon Aug 23 19:21:46 2021 +0530 Corrected spelling of MSColab commit 83551be Author: Hrithik Kumar Verma <[email protected]> Date: Mon Aug 23 17:35:37 2021 +0530 Added text files for kml, mscolab, wms, and views tutorials and fixed typos in tutorials.rst file commit c8b662b Merge: ee98974 3937b0a Author: ReimarBauer <[email protected]> Date: Mon Aug 23 07:41:44 2021 +0200 Merge pull request #1166 from risehr/documentation Created the tutorials.rst file commit 3937b0a Author: Hrithik Kumar Verma <[email protected]> Date: Mon Aug 23 02:32:17 2021 +0530 Fixed typos in performance settings text file commit 156fa36 Author: Hrithik Kumar Verma <[email protected]> Date: Mon Aug 23 02:22:41 2021 +0530 Added performance settings text file in tutorials/textfiles commit 6acc89e Author: Hrithik Kumar Verma <[email protected]> Date: Mon Aug 23 01:49:05 2021 +0530 Fixed typos in text files commit f681c0f Author: Hrithik Kumar Verma <[email protected]> Date: Mon Aug 23 01:18:54 2021 +0530 Updated tutorials.rst file and added some text files commit 0417b04 Author: Hrithik Kumar Verma <[email protected]> Date: Mon Aug 23 00:29:08 2021 +0530 Created the tutorials.rst file commit ee98974 Author: Hrithik Kumar Verma <[email protected]> Date: Sat Aug 21 13:59:43 2021 +0530 Mscolab tutorial, TTS feature for audios (#1162) * mscolab tutorial created * Created mscolab tutorial and added text to audio conversion feature for audio of the tutorial videos. Also updated tutorials.txt requirement file * Made some minor code improvements and rectified spelling mistakes * Made audio.py more customizable in terms of which translation and speech conversion APIs are to be used and also updated tutorials.txt requirement file * Removed the unnecessary comments commit df9aa18 Author: Hrithik Kumar Verma <[email protected]> Date: Tue Aug 17 14:11:38 2021 +0530 KML overlay, Hexagon Control, Performance settings tutorial completed (#1144) * Kml, hexagon control, and performance settings tutorial completed * Improved the screenrecorder class fixing some bugs, improved restricted size recording of windows * Minor changes in screen recorder class * made small changes in the header files of scipt and other minor changes in hexagon tutorial * Made the code more efficient by small changes in hexagon control tutorial commit bd3f251 Author: Hrithik Kumar Verma <[email protected]> Date: Mon Aug 9 18:55:26 2021 +0530 Remote Sensing and Satellite Track Tutorial (#1136) * Tutorial for remote sensing and satellite track and flexible/changeable screen recording area * Enabled FailSafe from screenrecorder.py file commit 5f70c3a Merge: 9170617 769b98a Author: ReimarBauer <[email protected]> Date: Fri Aug 6 16:58:51 2021 +0200 Merge pull request #1140 from Open-MSS/merged_develop_to_GSOC2021-HrithikKumarVerma Merged develop to gsoc2021 hrithik kumar verma commit 769b98a Author: ReimarBauer <[email protected]> Date: Fri Aug 6 16:25:42 2021 +0200 merge mistake fixed commit 7fd3765 Merge: 9170617 492482f Author: ReimarBauer <[email protected]> Date: Fri Aug 6 16:16:53 2021 +0200 Merge branch 'develop' into GSOC2021-HrithikKumarVerma commit 9170617 Merge: 6ab5a9d 36834c2 Author: ReimarBauer <[email protected]> Date: Wed Aug 4 09:28:13 2021 +0200 Merge pull request #1104 from risehr/views_tutorial [Completed] Automated tutorial for how to create a project in MSS using all the views. commit 36834c2 Author: Hrithik Kumar Verma <[email protected]> Date: Sun Aug 1 00:54:27 2021 +0530 Rectified some small mistakes such as remove extra space and unnecessary comments commit 41e83e1 Author: Hrithik Kumar Verma <[email protected]> Date: Sat Jul 31 02:51:43 2021 +0530 Made tutorial_views.py script to work for linux smoothly commit 0fee992 Author: Hrithik Kumar Verma <[email protected]> Date: Wed Jul 28 16:09:08 2021 +0530 Automated tutorial for how to create a project in MSS using all the views commit 6ab5a9d Author: Hrithik Kumar Verma <[email protected]> Date: Sun Jul 18 10:57:40 2021 +0530 Wms tutorial (#1083) * Made cursor visible and finished wms automated tutorial * flake8 corrections * Improved code for use in Linux systems.(It was working well in other systems) * Changed header file for the python scripts in mss/tutorials/* commit 3bb422c Merge: 2eda795 84ef56d Author: ReimarBauer <[email protected]> Date: Wed Jul 7 12:02:14 2021 +0200 Merge pull request #1074 from risehr/waypoints_tutorial Waypoints Tutorial : Working on Linux system now. commit 84ef56d Author: Hrithik Kumar Verma <[email protected]> Date: Mon Jul 5 21:08:40 2021 +0530 Rectified logical error in if statement; improved code to run both on linux and windows system efficiently commit 89d1417 Author: Hrithik Kumar Verma <[email protected]> Date: Mon Jul 5 18:45:50 2021 +0530 Modified waypoints tutorial to make it run smoothly on linux systems commit 2eda795 Author: Hrithik Kumar Verma <[email protected]> Date: Fri Jul 2 14:24:53 2021 +0530 Completed the waypoints tutorial and resolved the screen recording problems of being played too fast (#1067) * Allow specification of file for linear defaultstyle (#1028) * Allow specification of file for default * Simplify if condition * Increase coverage (#1020) * Add wms_control tests * Add more mscolab tests * Add mpl_qtwidget coverage * Add mss_pyui coverage * Add transparency, noframe and xml checks * Add more wms tests * Test import with plugins * Add linearview tests * Add more multilayering tests * Revert to old testing.yml * Leave no dangling windows * Remove todo, move ConnectionError to bottom Co-authored-by: ReimarBauer <[email protected]> * Migrate existing thermodynamic functions to metpy functions (#1009) * removed functions from thermolib.py functions to be replaced by metpy were removed * fixed: flake8 * fixed: flake8 * migrated to metpy functions Co-Authored-By: J. Ungermann <[email protected]> * Fixed: flake8 * Fixed: flake8 * Fixed tests * Fixed: flake8 * Fixed: failing tests * Ficed: tests * Units discarded upon returning results Co-Authored-By: J. Ungermann <[email protected]> * `omega_to_w` migrated to metpy Co-authored-by: ReimarBauer <[email protected]> Co-authored-by: J. Ungermann <[email protected]> * updated documentation (#1008) * updated documentation * improved install/update procedure Co-authored-by: Reimar Bauer <[email protected]> * Fixed: #999 (#1010) * .format replaced with f" string * updated copyright year * fixes #1014 (#1015) * Remove Qt imports (#1019) * Fixes #1014 changing http to https (#1017) Co-authored-by: ReimarBauer <[email protected]> * Linear view mscolab bug (#1021) * fixed tableview not opening bug; added test * added raising of mscolab window after closing view * preparation of v4.0.1 (#1023) * preparation of v4.0.1 * updated install instruction Co-authored-by: J. Ungermann <[email protected]> * Fix pyproj 3.1.0 error (#1033) * Made a screen recorder and automated tutorial for demonstrating use of waypoints * Renamed tut pictures to just pictures and moved the tutorials.txt to requirements.d * Minor bug fixes. (#1054) * Return proper unit for eq. potential temperature (degC->K) * Do not assume units of pressure levels for several old plotting styles. * Fix values of geopotential altitude in demodata * issue #719 solved (#729) * issue #719 solved * updated development.rst * updated development.rst Co-authored-by: ReimarBauer <[email protected]> * Select newest init-time and carry over multilayering (#1047) Co-authored-by: J. Ungermann <[email protected]> * Fix some issues with elevation caching and model level dimensions. (#1061) Fix #1066 * Added missing filename key. (#1062) See #1066 * Waypoints tutorial completed * Just changed the sleep timings of the code to make it more efficient : tutorial_waypoints.py * Added the updated tutorials.txt in requirements.d Co-authored-by: May <[email protected]> Co-authored-by: ReimarBauer <[email protected]> Co-authored-by: Jatin Jain <[email protected]> Co-authored-by: J. Ungermann <[email protected]> Co-authored-by: open-mss-build <[email protected]> Co-authored-by: Aryan Gupta <[email protected]> Co-authored-by: Aravind Murali <[email protected]> Co-authored-by: J. Ungermann <[email protected]> Co-authored-by: Archishman Sengupta <[email protected]> commit fca444a Author: Hrithik Kumar Verma <[email protected]> Date: Thu Jul 1 14:49:02 2021 +0530 Syncing my GSOC branch with develop (#1066) * Allow specification of file for linear defaultstyle (#1028) * Allow specification of file for default * Simplify if condition * Increase coverage (#1020) * Add wms_control tests * Add more mscolab tests * Add mpl_qtwidget coverage * Add mss_pyui coverage * Add transparency, noframe and xml checks * Add more wms tests * Test import with plugins * Add linearview tests * Add more multilayering tests * Revert to old testing.yml * Leave no dangling windows * Remove todo, move ConnectionError to bottom Co-authored-by: ReimarBauer <[email protected]> * Migrate existing thermodynamic functions to metpy functions (#1009) * removed functions from thermolib.py functions to be replaced by metpy were removed * fixed: flake8 * fixed: flake8 * migrated to metpy functions Co-Authored-By: J. Ungermann <[email protected]> * Fixed: flake8 * Fixed: flake8 * Fixed tests * Fixed: flake8 * Fixed: failing tests * Ficed: tests * Units discarded upon returning results Co-Authored-By: J. Ungermann <[email protected]> * `omega_to_w` migrated to metpy Co-authored-by: ReimarBauer <[email protected]> Co-authored-by: J. Ungermann <[email protected]> * updated documentation (#1008) * updated documentation * improved install/update procedure Co-authored-by: Reimar Bauer <[email protected]> * Fixed: #999 (#1010) * .format replaced with f" string * updated copyright year * fixes #1014 (#1015) * Remove Qt imports (#1019) * Fixes #1014 changing http to https (#1017) Co-authored-by: ReimarBauer <[email protected]> * Linear view mscolab bug (#1021) * fixed tableview not opening bug; added test * added raising of mscolab window after closing view * preparation of v4.0.1 (#1023) * preparation of v4.0.1 * updated install instruction Co-authored-by: J. Ungermann <[email protected]> * Fix pyproj 3.1.0 error (#1033) * Minor bug fixes. (#1054) * Return proper unit for eq. potential temperature (degC->K) * Do not assume units of pressure levels for several old plotting styles. * Fix values of geopotential altitude in demodata * issue #719 solved (#729) * issue #719 solved * updated development.rst * updated development.rst Co-authored-by: ReimarBauer <[email protected]> * Select newest init-time and carry over multilayering (#1047) Co-authored-by: J. Ungermann <[email protected]> * Fix some issues with elevation caching and model level dimensions. (#1061) Fix #1066 * Added missing filename key. (#1062) See #1066 Co-authored-by: May <[email protected]> Co-authored-by: ReimarBauer <[email protected]> Co-authored-by: Jatin Jain <[email protected]> Co-authored-by: J. Ungermann <[email protected]> Co-authored-by: open-mss-build <[email protected]> Co-authored-by: Aryan Gupta <[email protected]> Co-authored-by: Aravind Murali <[email protected]> Co-authored-by: J. Ungermann <[email protected]> Co-authored-by: Archishman Sengupta <[email protected]>

ReimarBauer · 2022-06-09T10:10:47Z

we create a new issue for other changes

joernu76 assigned ArchishmanSengupta Mar 19, 2021

ArchishmanSengupta added a commit to ArchishmanSengupta/MSS that referenced this issue Mar 22, 2021

issue Open-MSS#719 solved

71312b6

ArchishmanSengupta mentioned this issue Mar 22, 2021

issue #719 solved #729

Merged

ReimarBauer changed the title ~~Adding commands/Making changes in documentation of README file~~ Adding commands/Making changes in documentation of README file / development docs Mar 22, 2021

ReimarBauer mentioned this issue Jun 26, 2021

organize / reorganize Topics of the Development part #1052

Closed

ReimarBauer added a commit that referenced this issue Jun 28, 2021

issue #719 solved (#729)

3b4fdf1

* issue #719 solved * updated development.rst * updated development.rst Co-authored-by: ReimarBauer <[email protected]>

ReimarBauer closed this as completed Jun 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Adding commands/Making changes in documentation of README file / development docs #719

Adding commands/Making changes in documentation of README file / development docs #719

ArchishmanSengupta commented Mar 14, 2021

joernu76 commented Mar 19, 2021

ArchishmanSengupta commented Mar 19, 2021

joernu76 commented Mar 20, 2021

ArchishmanSengupta commented Mar 20, 2021

joernu76 commented Mar 20, 2021

ReimarBauer commented Mar 20, 2021

ArchishmanSengupta commented Mar 20, 2021

ArchishmanSengupta commented Mar 20, 2021

joernu76 commented Mar 21, 2021

ReimarBauer commented Jun 9, 2022

Adding commands/Making changes in documentation of README file / development docs #719

Adding commands/Making changes in documentation of README file / development docs #719

Comments

ArchishmanSengupta commented Mar 14, 2021

Currently the README of installation of the branch: develop is this:

📌 Prerequisites

💻 1. System requirement :

💿 2. Software requirement :

⚡ 3. Skill set :

📌Setting up the local environment

After this i will add the following:

🚩 Clone repository : [Adding a picture]

🚩 Setting up remote : [Adding a picture]

📌 Pushing your changes: [Adding a picture]

📌 Creating a pull request: [Adding a picture]

joernu76 commented Mar 19, 2021

ArchishmanSengupta commented Mar 19, 2021

joernu76 commented Mar 20, 2021

ArchishmanSengupta commented Mar 20, 2021

joernu76 commented Mar 20, 2021

ReimarBauer commented Mar 20, 2021

ArchishmanSengupta commented Mar 20, 2021

ArchishmanSengupta commented Mar 20, 2021

joernu76 commented Mar 21, 2021

ReimarBauer commented Jun 9, 2022

Currently the README of installation of the `branch: develop` is this: