Skip to content

Commit

Permalink
modified: README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
d31003 committed May 1, 2024
1 parent b11b84d commit 847d571
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# 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.
# Swarm Visualization
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 create pull request for new features.

## Usage
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`
Expand All @@ -14,20 +14,20 @@ Option 2:
pip install -e .
```

## Development
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]"
```
Please make sure to write unit test for every method that you are developing.
Please make sure to write unit tests for every method that you are developing.

Here's example import
Here's an example code to import functions from the package:

```python
from swarm_visualizer import plot_grouped_violinplot
from swarm_visualizer import plot_grouped_boxplot
from swarm_visualizer import plot_grid
```

0 comments on commit 847d571

Please sign in to comment.