= GSoC 2021 Improved Integration of GRASS GIS and Jupyter Notebooks=

|| Title: || '''Improved Integration of GRASS GIS and Jupyter Notebooks'' ||
|| Student Name: || Caitlin Haedrich, [https://cnr.ncsu.edu/geospatial/ North Carolina State University] ||
|| Organization: || [http://www.osgeo.org OSGeo - Open Source Geospatial Foundation] ||
|| Mentor Name: || Vaclav Petras, Helena Mitasova, Stephan Blumentrath ||
|| !GitHub Repository: || [https://github.com/chaedri/grass/  View Repo]  ||
|| GSoC proposal: || [https://docs.google.com/document/d/1ZT0cZobd87YCb3Ogis7RzWPj02XZkCpAHbC3VBGh7gc/edit?usp=sharing View Proposal]   ||

== Abstract ==
The current integration of GRASS GIS and Jupyter Notebooks requires a cumbersome environment variable setup after launching GRASS from within the notebook. It also only allows for simple, non-interactive map displays. My project will address both these issues and improve the GRASS-Jupyter integration with a new package called grass.jupyter.

== Goal ==
My goal is to design a Python/PyGRASS library which will have 3 main components for improving the GRASS-Jupyter integration: 
(1) creating new initiation functions for the launch of GRASS GIS in Jupyter Notebooks, 
(2) creating functions for more intuitive map display and, 
(3) introducing an interactive map display function.

== Timeline ==

{{{#!th style="background: #ddd" rowspan=2
'''Time Period'''
}}}
{{{#!th style="background: #ddd" colspan=2
'''Milestones'''
}}}
|-----------------------
{{{#!th style="background: #ddd"
Tasks
}}}
{{{#!th style="background: #ddd"
Status
}}}
|-----------------------
{{{#!td 
May 17th - June 7th\\
''Community Bonding''
}}}
{{{#!td
- Introduce myself in dev and SOC mailing lists
- Get in contact with mentors and discuss project
- Prepare the wiki page
- Set up the !GitHub repository for project
- Set up developer environment
}}}
{{{#!td
Ok \\
Ok \\
Ok \\
Ok \\
Ok
}}}
|-----------------------
{{{#!td 
June 7th - June 11th \\
''Week 1''
}}}
{{{#!td 
- Outline library architecture
- Write grass.jupyter initiation function
}}}
{{{#!td

}}}
|-----------------------
{{{#!td 
June 14th - June 18th \\
''Week 2''
}}}
{{{#!td 
- Write non-interactive display functions
}}}
{{{#!td

}}}
|-----------------------
{{{#!td 
June 21st - June 25 \\
''Week 3''
}}}
{{{#!td 
- Begin writing interactive/folium map functions
}}}
{{{#!td

}}}
|-----------------------
{{{#!td 
June 28 - July 2 \\
''Week 4''
}}}
{{{#!td 
- Finish writing interactive/folium map functions
}}}
{{{#!td

}}}
|-----------------------
{{{#!td 
July 5th - July 9th \\
''Week 5''
}}}
{{{#!td 
- Write test modules
}}}
{{{#!td

}}}
|-----------------------
{{{#!td style="background: #ddd"
July 12th - July 16th \\
''Week 6: Evaluations''
}}}
{{{#!td style="background: #ddd"
- Receive feedback and start second draft
}}}
{{{#!td

}}}
|-----------------------
{{{#!td
July 19th - July 23rd \\
''Week 7''
}}}
{{{#!td
- Revise and improve functions
}}}
{{{#!td

}}}
|-----------------------
{{{#!td 
July 26th - July 30th \\
''Week 8''
}}}
{{{#!td 
- Continue revising and improving functions
- Create documentation and tutorials.
}}}
{{{#!td

}}}
|-----------------------
{{{#!td 
August 2nd - August 6th \\
''Week 9''
}}}
{{{#!td 
- Finish Documentation and tutorials
}}}
{{{#!td

}}}
|-----------------------
{{{#!td 
August 9th - August 13th \\
'Week 10'
}}}
{{{#!td 
- Write project summary
}}}
{{{#!td

}}}
|-----------------------
{{{#!td style="background: #ddd"
August 16th- August 23rd \\
''Week 11: Final Evaluation and Code Submission''
}}}
{{{#!td style="background: #ddd"
- Submit code and final evaluation.
}}}
{{{#!td
}}}

== Bonding period report ==
With the bonding period wrapped up, here is a brief update on what I've been working on so far.

1. What did I accomplish during the bonding period?
- I introduced myself in dev and SOC mailing lists [1].
- I had a productive meeting with my mentors, Vashek Petras, Helena Mitasova and Stefan Blumentrath last Friday.  We discussed the best development environment (see second to last bullet point) and setting up the main GRASS repository to run in Binder (see last bullet point).
- Prepared the wiki page [2].
- Set up the GitHub repository for project [3].
- Set up developer environment. Since development will be easier on Linux, I set up a VirtualBox with Linux (Ubuntu) on my Windows machine. I compiled and installed GRASS and installed Jupyter Notebooks in Ubuntu.
- Opened my first PR [4] which contains binder dependencies.

2. What do you plan on doing next week?
I've started working on setting up the GRASS repository to run in Binder [4]. This week I plan to continue working on that, set up branches for each of the PRs, and begin writing functions for the grass.jupyter library.

3. Are you blocked on anything?
No, I'm not currently blocked on anything.

== Evaluation Status == 




== Weekly reports ==
== Week 1 ==

'''1) What did I get done this week?'''\\

'''2) What do I plan on doing next week?'''\\

'''3) Am I blocked on anything?'''\\


== Week 2 ==

== Week 3 ==

== Week 4 ==

== Week 5 ==

== Week 6 ==

== Week 7 ==

== Week 8 ==

== Discussion Notes ==

== Future Work ==