.git was too large -> reinit git.

.github/workflows/build.yml

@@ -0,0 +1,27 @@
+name: build
+on: [push, pull_request]
+jobs:
+  run:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        # os: [ubuntu-latest, macos-latest, windows-latest]
+        os: [ubuntu-latest]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: '3.8'
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Installation
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .
+          pip install -r requirements_dev.txt
+      - name: Test with pytest
+        run: |
+          pytest

.gitignore

@@ -0,0 +1,136 @@
+# mp4 or gif in tests/
+tests/**/*.mp4
+tests/**/*.gif
+
+.DS_Store
+notebooks/data/
+notebooks/outputs/
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/

.readthedocs.yaml

@@ -0,0 +1,20 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+   install:
+   - requirements: docs/requirements.txt

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Weizhe (Wesley) Chen
+
+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

@@ -0,0 +1,56 @@
+![code quality](https://img.shields.io/codefactor/grade/github/Weizhe-Chen/PyPolo/main)
+![build](https://github.com/Weizhe-Chen/PyPolo/actions/workflows/build.yml/badge.svg)
+![coverage](https://img.shields.io/codecov/c/github/Weizhe-Chen/PyPolo)
+![docs](https://img.shields.io/readthedocs/pypolo)
+![license](https://img.shields.io/github/license/Weizhe-Chen/PyPolo)
+![python](https://img.shields.io/pypi/pyversions/pypolo)
+<img src="https://img.shields.io/badge/PyTorch-%23EE4C2C.svg?style=for-the-badge&logo=PyTorch&logoColor=white" width="70"/>
+
+<img src="docs/assets/images/social/logo.svg" align="right" width="200" alt="header pic"/>
+
+<b>This project is still under active development!</b>
+
+## What Is PyPolo? 🧐
+PyPolo is a Python library for Robotic Information Gathering (RIG) -- a robotics research area that aims to answer:
+
+> **How does a robot (team) collect informative data to efficiently build an accurate model of an unknown target function under the robot's embodiment constraints?**
+
+<img src="docs/assets/images/framework/venn.png" width="70%"/>
+
+Depending on the definition of the target function, a RIG problem boils down to Active Mapping, Active Localization, Active SLAM, or Active Dynamics Learning.
+
+
+| Target Function | Problem |
+| --------|-----------------------|
+| Robot's Dynmaics | Active Dynamics Learning |
+| Robot's Pose | Active Localization |
+| Environment | Active Mapping|
+| Environment & Pose | Active SLAM |
+
+RIG has gained significant attention lately due to its broad range of applications, including environmental modeling and monitoring, 3D reconstruction and inspection, search and rescue, autonomous exploration and mapping, among others.
+
+An illustration of RIG's potential use case is an Autonomous Surface Vehicle (ASV) that efficiently constructs a precise underwater terrain map by actively gathering sonar measurements and minimizing uncertainty.
+
+<img src="docs/assets/images/framework/framework.png" width="70%"/>
+
+<img src="docs/assets/images/social/terrain_mapping.gif"  width="70%"/>
+
+## Why Would I Use PyPolo? 🤷
+
+You might be interested in this library if you would like to
+
+* **Learn** some robotics algorithms related to RIG painlessly;
+* **Research** and quickly prototype RIG algorithms, e.g., new planner, controller, model;
+* **Benchmark** your proposed algorithm with some popular baselines.
+
+We keep these needs in mind and provide
+
+* **Intuitive tutorials** to guide you to the world of RIG;
+* **Detailed documentation and readable code** to help you understand the basic idea of each algorithm;
+* **Minimum dependency and cross-platform support** so that you can start your robotics journey painlessly;
+* **Modular implementation** to facilitate the development of new algorithms;
+* **ROS integration guide** to demonstrate how to deploy the algorithms to simulated or real robots.
+* **A list of awesome** books, literature, related researchers, and other resources.
+
+Learning RIG can be daunting for beginners due to its highly integrated learning, planning, and control modules.
+Our aim is to provide an accessible starting point for those looking to learn RIG and jumpstart their research in this exciting domain.