Merge pull request #6 from UTAustin-SwarmLab/refactoring

Refactoring | Packaging

Author: minkyu-choi07

.gitignore

@@ -131,3 +131,8 @@ dmypy.json
 
 # customized
 .vscode/
+
+# Images
+*.jpg
+*.jpeg
+*.png

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 UTAustin-SwarmLab
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,16 +1,33 @@
-# plotting_utils
-Please use these plotting utilities for all papers, plots in lab slides, etc. If you find errors or need a new utility, feel free to push new functions. 
+# Swarm Visualizer
+This is a plotting visualizer packaged developed by UT Austin Swarm Lab. Please use these plotting package for all papers, plots in lab slides, etc. If you find errors or need a new utility, feel free to push new functions.
 
 ## Usage
-For example usage, see the code in the `examples` folder.
+For example usage, see the code in the `tests` folder. If you want to see example plots, run `pytest` in your terminal. All example plots will be available in `tests/example_plots`
 
-The plotting utilities are in the `plotting_utils` folder, which is a Python package. To use the plotting utilities, you must add the `plotting_utils` folder to your `PYTHONPATH`. For example, if you are using a bash shell, you can add the following line to your `.bashrc` file:
-```bash
-export PYTHONPATH=$PYTHONPATH:/path/to/plotting_utils
+
+If you are a user:
+```
+Option 1:
+pip install git+https://github.com/UTAustin-SwarmLab/Swarm-Visualization
+
+Option 2:
+pip install -e .
+```
+
+If you are a developer:
+```
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install --upgrade pip build
+python -m pip install --editable ."[dev, test]"
 ```
-where `/path/to/plotting_utils` is the path to the `plotting_utils` folder on your machine.
-Then you can use the plotting utilities in your Python code as follows:
+Please make sure to write unit test for every method that you are developing.
+
+Here's example import
+
 ```python
-from plotting_utils import *
+from swarm_visualizer.violinplot import plot_grouped_violinplot
+from swarm_visualizer.boxplot import plot_grouped_boxplot
+from swarm_visualizer.gridplot import plot_grid
 ```