Microbench -> Scope

c3sr · Jul 22, 2018 · 9b261c3 · 9b261c3
2 parents c674a9c + 7271ee6
commit 9b261c3
Show file tree

Hide file tree

Showing 40 changed files with 183 additions and 427 deletions.
diff --git a/.bumpversion.cfg b/.bumpversion.cfg
@@ -0,0 +1,7 @@
+[bumpversion]
+current_version = 0.1.2
+commit = True
+tag = True
+
+[bumpversion:file:scope_plot/__init__.py]
+
diff --git a/.coveragerc b/.coveragerc
@@ -1,6 +1,6 @@
 [run]
 include =
-    microbench_plot/*
+    scope_plot/*
 
 [report]
 exclude_lines =

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -1,5 +1,5 @@
 #### Version / Platform Info
-- MicrobenchPlot Version:
+- ScopePlot Version:
 - Happens in latest version? (Yes/No): 
 - Known Operating System(s) affected__:
   - [ ] Windows
@@ -21,7 +21,7 @@ This will significantly speed up the amount of time it
 takes to debug and resolve the issue for our contributors.
 
 ```python
-import microbench_plot
+import scope_plot
 
 # Please show the smallest possible example where
 # the issue occurs. This will drastically decrease

diff --git a/.travis.yml b/.travis.yml
@@ -19,7 +19,7 @@ after_success:
 jobs:
   include:
     # pycodestyle Style Checking
-    - python: 3.5
+    - python: 3.6
       env: TOXENV=pycodestyle
 
     # Documentation
@@ -59,11 +59,11 @@ jobs:
       deploy:
         provider: pypi
         user: ${PYPI_USER}
-        server: https://testpypi.python.org/pypi # Remove for deployment to official PyPi repo
         password:
           secure: ${PYPI_PASSWORD}
+        skip_cleanup: true
         on:
-          branch: master
+          tags: true
   allow_failures:
     - python: nightly
       env: TOXENV=py37
@@ -76,10 +76,3 @@ jobs:
 notifications:
   email: false
 
-branches:
-  only:
-  - master
-  - release
-  - develop
-  - ci
-
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,8 @@
+Changelog
+=========
+
+Release 0.1.2 (Development)
+---------------------------
+
+* rename to `scope_plot`
+* Initial support for `spec` and `bar` subcommands.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md
@@ -0,0 +1,22 @@
+Contributors
+------------
+
+## Author & Maintainer
+
+* Abdul Dakkak <dakkak@illinois.edu>
+* Carl Pearson <pearson@illinois.edu>
+
+## Contributors
+
+In chronological order:
+
+* Abdul Dakkak <dakkak@illinois.edu>
+    * Started the project
+* Carl Pearson <pearson@illinois.edu>
+    * Added CUDA communication benchmarks
+* Sarah Hashash <hashash2@illinois.edu>
+    * Added full-duplex CUDA memcpy benchmarks
+
+## Generating a Release
+
+See [RELEASE.md](RELEASE.md) for instructions on how to create a new release.
diff --git a/CONTRIBUTORS.rst b/CONTRIBUTORS.rst
diff --git a/MANIFEST.in b/MANIFEST.in
@@ -1,4 +1,4 @@
-include README.rst CHANGELOG.rst LICENSE.txt CONTRIBUTORS.txt requirements.txt dev-requirements.txt
+include README.md CHANGELOG.md LICENSE.txt CONTRIBUTORS.txt requirements.txt dev-requirements.txt
 recursive-include tests *
 recursive-include docs *
 recursive-exclude docs/_build *
diff --git a/README.md b/README.md
@@ -1,34 +1,33 @@
-MicrobenchPlot
-=======
+# ScopePlot
+
+[![Build Status](https://travis-ci.com/rai-project/scope_plot.svg?branch=master)](https://travis-ci.com/rai-project/scope_plot)
 
-[![Build Status](https://travis-ci.com/rai-project/microbench_plot.svg?branch=master)](https://travis-ci.com/rai-project/microbench_plot)
 
 Plot Google Benchmark results
 
-Getting Started with MicrobenchPlot
-----------------------------
+## Getting Started with ScopePlot
 
-MicrobenchPlot is available on TestPyPI can be installed with [pip](https://pip.pypa.io).
+ScopePlot is available on [PyPI](https://pypi.org/project/scope-plot/) can be installed with `pip`
 
-    $ python -m pip install --user --index-url https://test.pypi.org/simple/ --extra-index-url https://pypi.org/simple microbench_plot
+    $ python -m pip install scope_plot
 
-To install the latest development version from [Github](https://github.com/rai-project/microbench_plot).
+To install the latest development version from [Github](https://github.com/rai-project/scope_plot)
 
-    $ python -m pip install git+git://github.com/rai-project/microbench_plot.git
+    $ python -m pip install git+git://github.com/rai-project/scope_plot.git
 
-If your current Python installation doesn't have pip available, try `get-pip.py <bootstrap.pypa.io>`
+If your current Python installation doesn't have pip available, try [get-pip.py](bootstrap.pypa.io)
 
-After installing MicrobenchPlot you can use it like any other Python module.
+After installing ScopePlot you can use it like any other Python module.
 Here's a very simple example:
 
-```python
-python -m microbench_plot bar benchmark.json
+```bash
+$ python -m scope_plot bar data.json
 ```
 
 There are multiple subcommands available
 
 ```
-$ python -m microbench_plot --help
+$ python -m scope_plot --help
 
 Usage: __main__.py [OPTIONS] COMMAND [ARGS]...
 
@@ -43,27 +42,27 @@ Commands:
   spec  Create a figure from a spec file
 ```
 
-More information about the subcommands can be accessed with `python -m microbench_plot COMMAND --help`, and also in the documentation: [bar](docs/bar.md), [spec](docs/spec.md), [deps](docs/makefiles.md).
+More information about the subcommands can be accessed with `python -m scope_plot COMMAND --help`, and also in the documentation: [bar](docs/bar.md), [spec](docs/spec.md), [deps](docs/makefiles.md).
 
 API Reference
 -------------
 
-More coming soon...
+coming soon...
 
 Support / Report Issues
 -----------------------
 
 All support requests and issue reports should be
-[filed on Github as an issue](https://github.com/rai-project/microbench_plot/issues)
+[filed on Github as an issue](https://github.com/rai-project/scope_plot/issues).
 Make sure to follow the template so your request may be as handled as quickly as possible.
 Please respect contributors by not using personal contacts for support requests.
 
 Contributing
 ------------
 
-Guidance coming soon...
+We happily welcome contributions, please see [our guide for Contributors](CONTRIBUTORS.md) for the best places to start and help.
 
 License
 -------
 
-microbench_plot is made available under the MIT License. For more details, see [LICENSE.txt]( <https://github.com/rai-project/microbench_plot/blob/master/LICENSE.txt).
+scope_plot is made available under the MIT License. For more details, see [LICENSE.txt](https://github.com/rai-project/scope_plot/blob/master/LICENSE.txt).
diff --git a/RELEASE.md b/RELEASE.md
@@ -0,0 +1,33 @@
+# Steps to Release ScopePlot
+
+These are the steps to take to create a release of the module ``scope_plot``:
+
+1. Switch to the master branch
+
+```bash
+git checkout master
+```
+
+2. Run bump2version
+
+    0. Install bump2version (if needed)
+    ```bash
+    pip install --user bump2version
+    ```
+    1. Run bump2version with `patch`, `minor`, or `major`.
+    ```bash
+    bump2version --verbose patch
+    ```
+3. Update `CHANGELOG.md` and commit.
+
+```bash
+git add CHANGELOG.md
+```
+
+4. Add and commit the changes.
+
+```bash
+git push && git push --tags
+```
+
+4. Wait for [Travis](travis-ci.com/rai-project/scope_plot) to test/push.
diff --git a/RELEASE.rst b/RELEASE.rst
diff --git a/docs/README.md b/docs/README.md
@@ -1 +1 @@
-# MicrobenchPlot
+# ScopePlot
diff --git a/docs/bar.md b/docs/bar.md
@@ -1,10 +1,10 @@
-# microbench_plot bar
+# scope_plot bar
 
-MicrobenchPlot can be used to generate bar graphs without a full spec file.
+ScopePlot can be used to generate bar graphs without a full spec file.
 For example
 
 ```
-$ python -m microbench_plot bar --help
+$ python -m scope_plot bar --help
 
 Usage: __main__.py bar [OPTIONS] BENCHMARK OUTPUT
 
@@ -20,5 +20,5 @@ Options:
 The options allow you to plot only certain entries in the file, and to select specific fields from those benchmark entries to work as the x and y axis of the plot.
 
 ```bash
-python -m microbench_plot bar benchmark.json results.pdf --name-regex "NUMAUM_Prefetch_GPUToHost/.*/0/0" --y-field "bytes_per_second" --x-field=bytes
+python -m scope_plot bar benchmark.json results.pdf --name-regex "NUMAUM_Prefetch_GPUToHost/.*/0/0" --y-field "bytes_per_second" --x-field=bytes
 ```
diff --git a/docs/makefiles.md b/docs/makefiles.md
@@ -16,8 +16,8 @@ Here is an exmaple makefile for a directory organized in this way::
     └── specs
         └── ac922_prefetch_cpu-gpu.yml
 
-The `data` directory contains microbench data files.
-The `deps` directory will contain dependence files generated by microbench_plot
+The `data` directory contains Google Benchmark data files.
+The `deps` directory will contain dependence files generated by ScopePlot
 The `spec` directory contains specs to describe each generated figure
 The `generated` directory will contain one generated figure for each spec files
 

diff --git a/docs/source/_templates/fonts.html b/docs/source/_templates/fonts.html
diff --git a/docs/source/about.rst b/docs/source/about.rst
diff --git a/docs/source/api_reference/index.rst b/docs/source/api_reference/index.rst
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst