Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Plot class for ramp visualization and data analysis routines (isse #63) #89

Merged
merged 5 commits into from
Nov 8, 2023
Merged

Plot class for ramp visualization and data analysis routines (isse #63) #89

merged 5 commits into from
Nov 8, 2023

Commits on Nov 8, 2023

  1. Plot class for ramp visualization and data analysis routines (isse #63) 

    The new features added will allow the user to perform some data analysis
and visualization routines:

changes
------
*. ramp/post_process/post_process.py

- the class Plot is the main class carrying on the plotting and data
analysis functionalities with custom APIs providing access to some
pd.DataFrame features also easy to plot functions conencting to plotly
and matplotlibe methods.

- different plotting classes that include a specific plot type
  visualiztion using two different engines (plotly & matplotlib)

*. ramp.__init__.py
- adding the Plot class to the init.

documentation
-------------
- the functions API docuemntation is added to the API documentaiton
- A full example titled "Plot class" is added to the example gallery
  describing the full potential of the new functionalities
    @mohammadamint @Bachibouzouk
    mohammadamint authored and Bachibouzouk committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    747295b View commit details
    Browse the repository at this point in the history

  2. adding the new dependencies to the requirements

    @mohammadamint @Bachibouzouk
    mohammadamint authored and Bachibouzouk committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    da26874 View commit details
    Browse the repository at this point in the history

  3. Update RTD

    @Bachibouzouk
    Bachibouzouk committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    0c01599 View commit details
    Browse the repository at this point in the history

  4. PR #89 reviews 

    - Improving the Plot class docstring
- Improving the error handling with invalid inputs by user regarding the
  file extensions and plot engine
- Improving the readability of the plotting scripts by merging the plot
  classes into Plot methods
    @mohammadamint @Bachibouzouk
    mohammadamint authored and Bachibouzouk committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    511d90b View commit details
    Browse the repository at this point in the history

  5. Update docs requirements

    @Bachibouzouk
    Bachibouzouk committed Nov 8, 2023
    Configuration menu
    Copy the full SHA
    5766f8c View commit details
    Browse the repository at this point in the history