Skip to content

Commit

Permalink
Update setup and doc
Browse files Browse the repository at this point in the history
  • Loading branch information
AgarwalSaurav committed Apr 25, 2024
1 parent 446a020 commit 5634c25
Show file tree
Hide file tree
Showing 26 changed files with 366 additions and 278 deletions.
62 changes: 62 additions & 0 deletions .github/workflows/cd.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,68 @@ env:
FORCE_COLOR: 3

jobs:
make_sdist:
name: Make SDist
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Install dependencies
run: sudo bash ./setup_utils/install_dependencies.sh --boost --gmp --mpfr --eigen --cgal

- name: Build SDist
run: pipx run build --sdist

- uses: actions/upload-artifact@v4
with:
name: cibw-sdist
path: dist/*.tar.gz

build_wheels:
name: Wheel on ${{ matrix.os }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
os: [ubuntu-latest]

steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- uses: pypa/[email protected]

- name: Upload wheels
uses: actions/upload-artifact@v4
with:
name: cibw-wheels-${{ matrix.os }}-${{ strategy.job-index }}
path: wheelhouse/*.whl

upload_all:
needs: [build_wheels, make_sdist]
environment:
name: pypi
url: https://pypi.org/p/coverage-control
permissions:
id-token: write
runs-on: ubuntu-latest
if: github.event_name == 'release' && github.event.action == 'published'

steps:
- uses: actions/download-artifact@v4
with:
pattern: cibw-*
path: dist
merge-multiple: true

- uses: pypa/gh-action-pypi-publish@release/v1
# with:
# Remember to tell (test-)pypi about this repo before publishing
# Remove this line to publish to PyPI
# repository-url: https://test.pypi.org/legacy/
docker-deploy:
permissions: write-all
runs-on: ubuntu-latest
Expand Down
74 changes: 0 additions & 74 deletions .github/workflows/cd_wheels.yml

This file was deleted.

3 changes: 0 additions & 3 deletions .github/workflows/ghaction-doxygen-ghpages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,6 @@ on:
workflow_dispatch:
release:
types: [published]
push:
paths:
- 'doc/**'
permissions:
contents: write

Expand Down
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,16 @@ See full documentation at [https://KumarRobotics.github.io/CoverageControl/](htt

Coverage control is the problem of navigating a robot swarm to collaboratively monitor features or a phenomenon of interest not known _a priori_.
The library provides a simulation environment, algorithms, and GNN-based architectures for the coverage control problem.
<img align="right" width="300" src="https://github.com/KumarRobotics/CoverageControl/raw/main/doc/graphics/LPAC.gif">
<img align="right" width="300" src="https://kumarrobotics.github.io/CoverageControl/LPAC.gif">

**Key features:**
- The core library is written in `C++` and `CUDA` to handle large-scale simulations
- There are `python` bindings that interface with the core library
- Several Centroidal Voronoi Tessellation (CVT)-based algorithms (aka Lloyd's algorithms)
- Learnable Perception-Action-Communication (LPAC) architecture for the coverage control problem is implemented in `PyTorch` and `PyTorch Geometric`
- GPU and CPU parallelization using `CUDA` and `OpenMP`

---
## Quick Start
## Getting Started
The library is available as a `pip` package. To install the package, run the following command:
```bash
pip install coverage_control
Expand Down
Loading

0 comments on commit 5634c25

Please sign in to comment.