aboutsummaryrefslogtreecommitdiff
path: root/doc
AgeCommit message (Collapse)Author
2017-01-04Update ARM Ltd. copyright to 2017Brendan Jackman
2016-11-05doc/InteractivePlotter: Add example of plot fill paramsBrendan Jackman
2016-07-20doc: add examples for colour map in EventPlotMichele Di Giorgio
Signed-off-by: Michele Di Giorgio <michele.digiorgio@arm.com>
2016-07-08doc: make one plot in the InteractivePlotter have only one columnJavi Merino
There are codepaths that are only exercised when we plot only one column but all the plots in InteractivePlotter have two columns/signals. Change one to increase the testing done by the notebook.
2016-07-07Merge pull request #206 from JaviMerino/ilineplot_xlim/v1Kapileshwar Singh
ILinePlot: only pass the necessary data when xlim is passed
2016-07-06doc: Use an example of xlim in the InteractivePlotter notebookJavi Merino
The InteractivePlotter accepts xlim as a parameter. Add an example to show it and to test that it works.
2016-07-04doc: Document the new "colors" parameter to the plotterJavi Merino
2016-07-04doc: Document the signal color parameterJavi Merino
The signal spec now accepts an optional third parameter which is the color. Document it so that people know about it.
2016-06-16trappy: set the version using an explicit fileJavi Merino
There is no pythonic way of specifying the version of a project, [0] describes 7 (seven!) ways of doing it. We were currently using method 5, setting the value in setup.py and using pkg_resources to get it from the installed version. This works ok if you have installed the package using "python setup.py" or pip, but fails if you are importing trappy from a checkout, which is what lisa do. Even worse, if you import it from lisa but have an old trappy version installed, trappy.__version__ will tell you the version of the installed trappy, not the one you have imported and are using. Switch to use a version.py file that's distributed with the project (method 3). trappy.__version__ now reads the imported trappy's version, which is what you want. setup.py and the documentation read the file when they are installing so as to avoid repeating the version number there. [0] https://packaging.python.org/en/latest/single_source_version/
2016-06-01Merge pull request #192 from mdigiorgio/axes-limitsJavi Merino
StaticPlot: pass xlim and ylim through to matplotlib
2016-06-01StaticPlot: pass xlim and ylim through to matplotlibMichele Di Giorgio
In Static plots, xlim and ylim were ignored causing the user to not see the effect of setting limits to X and Y axes. Also, an example of usage of those parameters is added to the Plotter notebook as a reference on how to use them. Signed-off-by: Michele Di Giorgio <michele.digiorgio@arm.com>
2016-06-01setup: release trappy 5.5.0Javi Merino
2016-05-09doc: document trappy.nbexportJavi Merino
Document how to use trappy.nbexport to generate HTML versions of notebooks.
2016-05-09doc: fix indentation in InteractivePlotterJavi Merino
Yet another commit sponsored by my OCD.
2016-05-09doc: fix "heading 3" without "heading 2" in InteractivePlotterJavi Merino
The InteractivePlotter documentation has a couple of "Heading 3"s without any "heading 2"s. One of them is just a note to the user to rerun the cells. The other can be promoted to "heading 2".
2016-05-09doc: remove trace2 from InteractivePlotter documentationJavi Merino
As far as I can see, this was introduced in 584f88debf51 ("doc: Add Documentation for Interactive Plotting") but never used.
2016-05-03setup: release trappy 5.4.0Javi Merino
2016-04-01setup: release trappy 5.3.0Javi Merino
2016-03-15doc: Add an example of synchronized zoomJavi Merino
2016-03-04doc: add IPlot examples with independent seriesMichele Di Giorgio
Signed-off-by: Michele Di Giorgio <michele.digiorgio@arm.com>
2016-03-01setup: release trappy 5.2.0Javi Merino
2016-02-29doc: merge PlotterPermute into PlotterJavi Merino
The permute documentation is just more documentation about plotter, so add a new heading to it.
2016-02-29doc: Update the notebooks to show the new looks of the static plotsJavi Merino
2016-02-29doc: Don't use pylab inlineJavi Merino
It's a bad habit, it imports a lot of things into the global namespace. Use "%matplotlib inline" instead.
2016-02-19doc: fix misspellingMichele Di Giorgio
2016-02-16doc: add notebook example to show usage of permute parameterMichele Di Giorgio
2016-02-16plotter: StaticPlot: make_title show trace name only for single trace plotsMichele Di Giorgio
The make_title function now prints the trace name only when needed, that is when a single trace is being plot. In fact, in this case there will be no legend and it is good to let the reader know which trace is shown by putting its name in the title. On the contrary, where there are more traces, the legend is generated and therefore putting names in the title becomes redundant.
2016-02-10doc: Update copyright to 2016Javi Merino
2016-02-10setup: release trappy 5.1.0Javi Merino
2016-01-29doc: Add an example notebook for BarPlotterJavi Merino
Change-Id: I4b2c29789dcba57611c38ed4d127733ec8c0bdb9
2016-01-15doc: add documentation for ILinePlot with generic DataFramesJavi Merino
This will serve both for everybody to remember that this is there and as a soft test that it actually works.
2016-01-05setup: release trappy 5.0.1Javi Merino
Minor fix to setup.py
2016-01-05setup: release trappy 5.0.0Javi Merino
trappy.stats.SchedConf disappeared in 861e6526a9b2 ("stats: Remove Scheduler specific functions"), which is a change in the API. Bump the major number.
2016-01-05trappy: update copyright to 2016Javi Merino
2015-12-22dynamic: ensure dynamic methods refer to ftraceJavi Merino
Now that we can have traces coming from sources other than ftrace, rename register_dynamic() and register_class() to register_dynamic_ftrace() and register_ftrace_parser() to make it clear that they are only available for traces coming from ftrace.
2015-12-22doc: add simple documentation for the BareTrace classJavi Merino
2015-12-22ftrace: rename Run to FTraceJavi Merino
Run is a very generic and inappropriate name for an object that parses the result of ftrace into a form consumable by python. Rename it to FTrace in preparation for its generalization.
2015-12-17docs: Update documentation for map labelsKapileshwar Singh
Signed-off-by: Kapileshwar Singh <kapileshwar.singh@arm.com>
2015-12-15doc: Add documentation for Stats FrameworkKapileshwar Singh
Signed-off-by: Kapileshwar Singh <kapileshwar.singh@arm.com>
2015-12-04docs: Update URL path for MathJaxKapileshwar Singh
This is to avoid the error: <parent_URL> was loaded over HTTPS, but requested an insecure script: 'http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML' This request has been blocked; the content must be served over HTTPS. Signed-off-by: Kapileshwar Singh <kapileshwar.singh@arm.com>
2015-12-01setup: release trappy 4.0.0Javi Merino
The API for the grammar parser changed in 5dae68e080f7 ("stats: grammar: Remove Topology argument") so increase the major number.
2015-11-27doc: Add documentation for signals in PlotterKapileshwar Singh
Signed-off-by: Kapileshwar Singh <kapileshwar.singh@arm.com>
2015-11-26doc: document the events parameter of the Run classJavi Merino
2015-10-16doc: Update notebook for InteractivePlotterKapileshwar Singh
Update documentation for usage of lanes for EventPlot Signed-off-by: Kapileshwar Singh <kapileshwar.singh@arm.com>
2015-09-22doc: Add Sphinx documentationKapileshwar Singh
Signed-off-by: Kapileshwar Singh <kapileshwar.singh@arm.com>
2015-09-07doc: Add Documentation for Interactive PlottingKapileshwar Singh
Signed-off-by: Kapileshwar Singh <kapileshwar.singh@arm.com>
2015-08-13trappy: rename to trappyJavi Merino
Change-Id: I7e0e34c9f5565e34629683bb29ab25cf5e737088
2015-08-13doc: move one of the trace test files to the doc/ folderJavi Merino
The tests/ folder is not available for external people. By having an example trace in the doc/ folder, people that download cr2 from dropzone can play and modify the examples. Change-Id: I866c1d254b8cb72664bad14611c1159f975bf46a
2015-08-13doc: update the documentation with the new paths in the tests folderJavi Merino
Change-Id: I97398f36bb753a9cd2cfe26bda71bc46858428eb
2015-08-13wa: rename the id optional parameter to nameJavi Merino
id is a python built-in. Don't use it as a name of a parameter. Change-Id: I0ee59d55eae0d4a336ffc73693ce021ea28ba1e9