Planned Progress
Final submission

Progress

• Started the iruby and ticks blog - https://alishdipani.github.io/gsoc2019/2019/08/22/IRuby-integration-and-ticks/

Problems

Plan
23 August - Complete the blogs
24 August - Finish the final blog and final submission

Planned Progress
Final submission

Progress

• Removed line_opacity option from Line plot and plot function
• Corrected line_color argument in Line plot
• Completed the tutorial

Problems

Plans

• Same as above

Planned Progress
Final submission

Progress

• Improved line plot, area plot and histogram
• Improved tick labels
• Improved the tutorial

Problems

Plan

• Same as above

Planned Progress
Final submission

Progress

• Implemented minor ticks

Problems

Plan
20 Aug - Improve tick labels, complete tutorial, complete iruby blog
21 Aug - Add ticks to iruby blog, complete multiplots blog
22 Aug - Final blog and submission
23 Aug onwards - Documentation, look into gem installation with GR backend

The tutorial is hosted on nbviewer as Github might not render the large tutorial

Planned Progress
Creating a tutorial for Rubyplot in iruby notebook

Progress

• Updated the tutorial
• Implemented major ticks

Problems

Plans

• Complete the tutorial
• Implement minor ticks
• Write documentation
• Complete blogs

Planned Progress
Creating a tutorial for Rubyplot in iruby notebook

Progress

• Had the weekly meeting with Sameer
• Started the tutorial [link]

Meeting details
To-do before the start of final evaluations-

1. Create the tutorial
2. Write documentation
3. Implement ticks
4. Complete the multi-plots blog and write a blog for iruby integration

To-do during final evaluations -

1. Write a final blog with summary of GSoC, all blog links and all code, repo and PR links
2. Do the final submission

Problems

Plans

• Complete the tutorial
• Implement ticks
• Write documentation

Planned Progress
Integrating iruby with Rubyplot

Progress

• Integrated Rubyplot with iruby notebook for Magick backend
• Corrected the bug for changing the properties of canvas after first declaration

Examples

1. Inline show (called Rubyplot.inline)
   

   

2. Stoped inline (called Rubyplot.stop_inline)
   

Problems

• GR backend is not yet integrated as set_backend function gives an error
• To integrate GR backend and other backends in future, the approach mentioned in the previous update can be used

Plans

• Complete the blogs
• Implement ticks

Planned Progress
Integrating iruby with Rubyplot

Progress

• Looked into nyaplot code

Problems

• Nyaplot uses image embedded in HMTL code to display on iruby notebook, it only uses show function to show images in iruby notebook and not independently i.e. no pop-up windows
• To make the iruby integration consistent across backends and easily scalable, the function should not depend on the backends i.e. no specific properties of Magick or GR should be used
• I think the best way to go for this is to store a temporary image using write function and then load the image and display it in iruby notebook

Plans

• Complete the integration

Planned Progress
Integrating iruby with Rubyplot

Progress

• Looked into the nyaplot code

Problems

Plans

• Complete the iruby integration over the weekend

Planned Progress
Integrating iruby with Rubyplot

Progress

• Had the weekly meeting with Sameer.
• Looked into building Rubyplot as gem, built it
• Tested Rubyplot in irb and iruby notebook

Problems

• During building the gem, there were some warnings
• Rubyplot.set_backend is needed to be called to set the backend i.e. no default? (maybe because of next problem)
• While setting GR backend using the command above there is an error NameError (uninitialized constant Rubyplot::Backend::GRWrapper)

Meeting details

• Updated Sameer about the progress
• Discussed things to be completed before final evaluation i.e. iruby integration, tutorials and ticks
• Writing a blog on iruby integration while trying to generalize the method for integration for future users.
• Useful links:

1. https://github.com/mrkn/matplotlib.rb/blob/master/lib/matplotlib/iruby.rb
2. https://github.com/domitry/nyaplot
3. https://github.com/domitry/nyaplot/blob/master/lib/nyaplot/templates/iruby.erb
4. https://github.com/domitry/nyaplot/blob/master/lib/nyaplot/plot.rb#L83

Plans

• Look into the error for GR
• Look into integration of show function with iruby notebook

Planned Progress
Integrating iruby with Rubyplot

Progress

• Completed setting up Rubyplot
• Installed and tested out iruby notebooks
• added a new method print_on_device to avoid code duplication in write and show

Problems

• To include Rubyplot, should it be installed as a gem?

Plan

• integrate iruby with rubyplot

Planned Progress
Integrating iruby with Rubyplot

Progress
Tried to set up Rubyplot on my laptop but rmagick installation is giving some errors

Problems
I will find a solution for the errors and will continue the work

• rmagick installation was having errors
• Ruby was not working correctly due to presence of multiple versions

Plan

• Set up Rubyplot
• Work as planned

Planned Progress
Integrating iruby with Rubyplot

Progress
Tried to set up Rubyplot on my laptop but rmagick installation is giving some errors

Problems
I will find a solution for the errors and will continue the work

Plan

• Set up Rubyplot
• Work as planned

Planned progress

Progress
Looked into iruby notebboks codebase

Problems

Plans

• Integrate Rubyplot with iruby notebooks
• Complete the remaining blog
• Make a list of polts

Planned progress
Writing plot function tests

Progress

• Passed all the tests for plot function
• Completed the blog for simple plots in Rubyplot, Link: https://alishdipani.github.io/gsoc2019/2019/06/28/Simple-Plots-in-Rubyplot/
• Completed the blog for show and the plot function, Link: https://alishdipani.github.io/gsoc2019/2019/07/26/The-show-and-the-plot-functions/

Problems

Plans

• Write tests for fmt argument of the plot function
• Complete the multi plots blog
• Look into iruby notebooks

Worked on Code review and the blogs

Planned progress
Working on Plot function

Progress

• worked on blogs

Problems

Plans

• Complete the blogs
• Create a list of plots
• Implement remaining marker and line types

COLOR_TYPES_FMT = {
          'b' => :blue,
          'g' => :green,
          'r' => :red,
          'c' => :cyan,
          'm' => :magenta,
          'y' => :yellow,
          'k' => :black,
          'w' => :white
    }.freeze

    MARKER_TYPES_FMT = {
      '.' => :dot,
      ',' => :omark,
      'o' => :circle,
      'v' => :traingle_down,
      '^' => :traingle_up,
      '<' => :solid_tri_left,
      '>' => :solid_tri_right,
      '1' => :solid_triangle_down,
      '2' => :solid_triangle_up,
      '3' => :solid_tri_left,
      '4' => :solid_tri_right,
      's' => :square,
      'p' => :pentagon,
      '*' => :star,
      'h' => :hexagon,
      'H' => :heptagon,
      '+' => :plus,
      'x' => :diagonal_cross,
      'D' => :solid_diamond,
      'd' => :diamond,
      '|' => :vline,
      '_' => :hline
    }

    LINE_TYPES_FMT ={
      '--' => :dashed,
      '-.' => :dashed_dotted,
      '-' => :solid,
      ':' => :dotted
    }

Planned progress
Working on Plot function

Progress

• Finished implementing the frontend for the plot function
• Had a weekly meeting with @v0dro

Problems

Meeting summary
To-do list before 2nd evaluation starts:

• Implement the plot function frontend (done)
• Create a list of plots
• Complete the blogs
• Implement the remaining marker and line types, as many as possible

Plans

• Complete the blogs
• Create a list of plots
• Implement remaining marker and line types

dot .
plus +
asterisk *
circle O
diagonal_cross x
solid_circle sO
triangle_up ^
solid_triangle_up s^
triangle_down v
solid_triangle_down sv
square q
solid_square sq
bowtie b
solid_bowtie sb
hglass h
solid_hglass sh
diamond d
solid_diamond sd
star s
solid_star ss
tri_up_down ^v
solid_tri_right s>
solid_tri_left s<
hollow_plus h+
solid_plus s+
pentagon p
hexagon hx
heptagon hp
octagon oc
star_4 s4
star_5 s5
star_6 s6
star_7 s7
star_8 s8
vline |
hline _
omark o

Line type symbols:
solid -
dashed –
dotted -.
dashed_dotted --.
dash_2_dot -…
dash_3_dot -…
long_dash —
long_short_dash –
spaced_dash --
spaced_dot ._.
double_dot …
triple_dot …

Planned progress
Working on Plot function

Progress

• Worked on format of fmt argument
• Added error handling of large figures for magick backend

Problems

Plans

• Complete blogs(Will be done by Wednesday)
• work on plot function
• Implement remaining marker and line types
• Create a list of plots
• Implement ticks

v0dro:

Yes. Use initialization for now.

sure

gets doesn’t work, it waits for some time (I think this is GR default) and then gives this error:
Failures:

1. Rubyplot::Axes b: #Rubyplot::Backend::GRWrapper:0x00005572753e6150. #plot! plots a simple plot with plus marker of green color
   Failure/Error: hold = gets

   Errno::ENOENT:
   No such file or directory @ rb_sysopen - --t=focus
   /# ./lib/rubyplot/backend/gr_wrapper.rb:350:in ‘gets’
   /# ./lib/rubyplot/backend/gr_wrapper.rb:350:in ‘gets’
   /# ./lib/rubyplot/backend/gr_wrapper.rb:350:in ‘stop_output_device’
   /# ./lib/rubyplot/artist/figure.rb:116:in ‘show’
   /# ./spec/axes_spec.rb:118:in ‘block (3 levels) in <top (required)>’

I will make the necessary changes.

I’ll figure a way for this

okay

Yes, they’ll be done by Wednesday EOD

AlishDipani:

Suppose I call the write/show function and then add a plot in a subplot without initializing, it doesn’t work. But if it is initialized again, it works. So, it is necessary to initialize again after calling the write/show function.
The same thing happens with matplotlib, initialization is necessary. @v0dro

Yes. Use initialization for now.

Hmmm I’m not too familiar with this part of the GR backend. However I do remember that Pranav had tried to do something similar with GR. Here’s the script that he made: https://github.com/pgtgrly/GRruby-extension/blob/master/examples/GRFramework/Example.rb#L54

I haven’t used this script in a long time but as far as I remember, it does work.

Yes. This should depend on the format string provided by the user.

I’d prefer both. Ruby symbols with full names or strings with shortcuts like in Python.

Just throw an error.

Also, finish the blogs faster.

Planned progress
Working on the plot function

Progress

• Looked into the plot function frontend
• Corrected the tests for plot function, changed the unit of the input of sin and cosine from radians to degrees

Problems

• The backend of the plot function uses Line2D(draw_lines) and draw_markers which are already implemented for Magick except for the line types and some marker types.
• The plot function currently either plots lines or markers, but ideally, it should do both (if specified)
• For the format of fmt argument, the string format should be decided, options are keeping it short like matplotlib or having full strings
• There should be different options for marker_fill_color and marker_border_color and line colour
• Magick backend can not plot a figure having size 400 cms

Plans

• Complete the blogs
• Create a list of plots
• Implement remaining marker and line types
• Work on Plot
• Implement ticks

Planned progress
Documentation for show function

Progress

• Had the weekly meeting with @v0dro
• Improved the show function
• Tested with different combinations of the show and write and changing the plots in between

Problems

• Suppose I call the write/show function and then add a plot in a subplot without initializing, it doesn’t work. But if it is initialized again, it works. So, it is necessary to initialize again after calling the write/show function.
  The same thing happens with matplotlib, initialization is necessary. @v0dro
• GR backend does not wait at the show function, suppose I call it two times, it shows the first time for a very short amount of time and then the second one for longer, is there any way to stop it at a show function and allow the user to keep it displaying for however long the user wants and then when a command is given then the code is executed further, @v0dro could you help me with this?

Meeting summary
Summary and To-do list:

• Discussed optimizing the show function without having to save the is_initialized state variable
• Discussed the device argument

Plans

• complete the blogs
• Create a list of plots
• implement ticks

v0dro:

Did you try using a variable to indicate change of state as we had discussed over the call?

Yes, I did try it but it had some issues related to calling the init_output_device and stop_output_device functions. I will explain the issues in more detail in today’s call.

AlishDipani:

If after calling show on a figure, a plot is added to a subplot and then write is called then the figure is not as expected. This happens for both the backends(similar incorrect figure is drawn)

Did you try using a variable to indicate change of state as we had discussed over the call?

Planned progress
Implement show function for GR

Progress

• Implemented a basic show function for GR backend

Problems

• If after calling show on a figure, a plot is added to a subplot and then write is called then the figure is not as expected. This happens for both the backends(similar incorrect figure is drawn)
• the device argument is always kept as a file, which indicates saving the figure. Another option is window which is for displaying the figure. This argument can be removed, I will look into this soon.

Plans

• solve the bug for consecutive show and write calling
• complete the blogs
• Create a list of plots
• implement ticks

Planned progress
Implement show function for GR

Progress

• Focussing on Magick backend and leaving GR backend for now
• Implemented the show function for Magick backend

Problems

• The show function is not optimized, I tried optimization by not initialization the figure again but there were some errors which couldn’t be resolved. I will try to resolve the error or find another way for optimization

Plans

• Optimize the show function
• Complete the blogs
• Create a list of plots
• Implement ticks

Planned progress
Checking subplots

Progress

• worked on ticks

Problems

Plans

• Improve ticks
• Write blogs
• Create a list of plots

Planned progress
Checking subplots

Progress

• Had the weekly meeting with @v0dro
• Passed the tests for subplots, the outputs:
  GR:
  
  

Magick:

• Added the default value for marker_fill_color for scatter plot in the frontend
• Added the flag for square axes in the axes frontend
• Implemented square axes for Magick backend
• Increased the line width for axes for Magick backend so that it looks better (set the width to 5 pixels)
• Corrected the spacing ratio function for the bar plot
• Improved plots for Magick backend, the axes are now plotted above the figures

Problems

• GR backend lacks the square axes

Meeting summary
To-do list:

1. Complete the blogs
2. Implement ticks
3. Write documentation
4. Check subplots (done)
5. Submit a proposal for RubyConf USA
6. Increase the line width for axes in Magick backend (done)
7. Draw axes above the figures (done)
8. Implement rectangular axes (done)
9. Improve the testing script so that tests for both backends are done in one go
10. Erase the figures which are out of bounds for Magick backend
11. Look into legend box for all the multi plots
12. Take x values as inputs for all the multi plots
13. Look into spacing for candle stick plot (done) -> @v0dro the spacing is there but it is not that visible if the figure is too big
14. Create optimized show function such that if write is called just after it then the plotting should not be done again.

Plans

• Complete blogs
• Create a list of plots
• Implement ticks

GR:

Magick:

Planned progress
Implement grouped box plot

Progress

• Looked into the working of ticks

Problems

• GR backend does not use the input properties and creates ticks in its own way, will discuss this in weekly meeting with @v0dro

Plans

• Complete blogs
• Implement ticks
• Create a list of plots

Planned progress
Implement grouped box plot

Progress

• Since the front end of grouped box plot is not implemented, leaving it for now and focusing on other plots

• Passed tests for stacked and multi stacked bar plot, outputs:
  

  
  
  
  

• Corrected the y inversion of subplots for Magick backend

• Added opacity as 0.5 to bubble plot by using drawing circles instead of markers, had to change the front end of bubble plot

• Changed front end of Circle object to replace border_opacity with fill_opacity

• Introduced a nominal factor for draw_circle in Magick backend to match the sizes of GR backend

Problems

• Stacked bar plot lacks legend box
• GR backend does not implement opacity for draw_circle function

Plans

• Complete blogs
• Implement ticks
• Make a list of plots with examples and problems in them

Planned progress
Check multi stacked bar plot

Progress

• Checked and passed tests for multi box plot, outputs:
  
  
• Corrected multi candle stick plot, the bug was that it was plotting one candle stick less
• Checked and passed tests for multi candle stick plot, output:
  

Problems

• Both candle stick and box plot lack legend box
• Single box plot, candle stick plot, etc. utilise multi plots and hence I will include this in the blog as well, due to which the blog will take some time
• Both candle stick plot and box plot do not take x values as inputs, but matplotlib has the necessary condition of giving x values as input, should this be incorporated here as well? @v0dro
• I had not checked stacked bar plot earlier, and hence will check that first and then move to multi stacked bar plot

Plans

• Work on blogs
• Check stacked bar plot and multi stacked bar plot
• Implement ticks

Planned progress
check multi candle stick plot

Progress

Problems

• Could not work today due to some personal issues and visa application

Plans

• Complete the remaining work

Planned progress
Check multi box plot

Progress

• Worked on blogs

Problems

• Will check the multi box plot in addition to next day’s work.

Plans

• Complete the blogs
• Implement ticks
• Check multi box plot
• Check multi candle-stick plot

Planned progress
Check multi bar plot

Progress

• Worked on blog
• Wrote an experimental test for multi bar plot and the output is correct
  data given =

[["Data1", [4, 7, 12], :blue],
 ["Data2", [2, 6, 10], :yellow],
 ["Data3", [3, 8, 11], :red],
 ["Data4", [1, 5, 9], :black]]

Output for GR backend:

Output for Magick backend:

• Corrected the function for the input of spacing_ratio in bar plot

Problems

• I will complete the blog in 1-2 days
• What is the purpose of the stacked_bar plot? is it different than a simple bar plot? @v0dro
• I saw that there is a test for dot plot but there is no such plot, should dot plot be added? @v0dro
• Matplotlib allows the user to set the x coordinates, whereas in Rubyplot it is decided by us, should there be an option to take the x values as an input? @v0dro
• Bar plot does not create legend box (or it is not visible)

Plans

• Complete the blogs
• Implement ticks

• Check multi box plot

Planned progress
Complete Evaluation

Progress

• Completed the Rubyplot installation guide blog, link: https://alishdipani.github.io/gsoc2019/2019/06/09/Rubyplot-installation-guide/
• Worked on the blog for plots

Problems

• I will apply for my visa soon and the appointment for it will be on Tuesday or Wednesday and hence I will be unavailable to work for 2-3 days during that time.

Plans

• Complete the blogs
• Implement ticks

Planned progress
Complete Evaluation

Progress

• Worked on the blogs

Problems

Plans

• Complete the blogs
• Implement ticks

v0dro:

Here’s some more feedback regarding the blog post:

As an example, in the Setting Output Device part of the post, you’ve a detailed explanation of the function of each within the method init_output_device . But what is missing here is the ‘purpose’ of each line. I can see that you’re creating three Magick::Draw objects. But WHY create three objects? What were the underlying design decisions that lead to creation of three objects instead of just one? These things are much more interesting to someone reading your post to get a technical overview. They also serve as guidelines later when a developer is wondering about the purpose of the code.

Another example is that we do not use the MATLAB notation for creating subplots (which is used by matplotlib). Would be great if you can write the reasons for that too.

Also explain why you do the text rotation in Magick the way you do.
Please make such updates to your post before moving on to the next one.

@v0dro I am creating another blog for this which explains the code and the purpose of the functions and the design decisions as well. Link: https://alishdipani.github.io/gsoc2019/2019/06/12/Setting-up-the-ImageMagick-backend/

I will complete this blog and the blog for plots hopefully by Saturday EOD

Planned progress
Complete Evaluation

Progress

• Completed code review
• decided on the format and what all is to be included in the next blog

Problems

• User guide for installation of Magick backend is not present.

Plans

• Complete the blogs
• Implement ticks

Planned progress
Complete Evaluation

Progress

• Working on Code review

Problems

Plans

• Complete the blogs
• Implement ticks

Planned progress
Working on Violin plot

Progress

• Not working on Violin plot for now as the frontend is not implemented
• Improved The scatter plot example blog
• Corrected the Line plot Frontend

Problems

Plans

• Working on Blogs
• Completing the remaining work