Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
167 changes: 152 additions & 15 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,41 +1,169 @@
# Python
# 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/
share/python-wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
*.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
*.log
.hypothesis/
.pytest_cache/
cover/

# 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/
docs/_static/
docs/_templates/

# PyBuilder
.pybuilder/
target/

# Jupyter Notebook
.ipynb_checkpoints
*.ipynb

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# pipenv
Pipfile.lock

# poetry
poetry.lock

# pdm
.pdm.toml

# PEP 582
__pypackages__/

# Celery stuff
celerybeat-schedule
celerybeat.pid

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
*.egg-info/
dist/
build/
*.egg
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/

# pytype static type analyzer
.pytype/

# Cython debug symbols
cython_debug/

# IDEs
.vscode/
.idea/
*.swp
*.swo
*~
.DS_Store

# Jupyter
.ipynb_checkpoints/
*.ipynb

# Testing
.pytest_cache/
.coverage
htmlcov/
.project
.pydevproject
.settings/

# Data and Models
*.bag
*.pth
*.pkl
*.h5
*.ckpt
*.hdf5
*.npy
*.npz
datasets/
data/
logs/
output/
results/
checkpoints/
models/*.zip
models/*.pth

Expand All @@ -50,4 +178,13 @@ log/

# OS
Thumbs.db
*.log
.DS_Store
*.bak
*.tmp
*~

# Project specific
*.trajectory
*.plan
temp/
tmp/
144 changes: 144 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,144 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]

### Added
- Comprehensive documentation suite
- Installation guide (docs/installation.md)
- Quick start tutorial (docs/quickstart.md)
- Complete API reference (docs/api_reference.md)
- System architecture documentation (docs/architecture.md)
- Robot models documentation (robots/README.md)
- Modern Python project configuration (pyproject.toml)
- Development dependencies (requirements-dev.txt)
- Trajectory visualization script (scripts/visualize_trajectory.py)
- Full CI/CD pipeline with GitHub Actions
- Docker support with docker-compose.yml

### Changed
- Updated README.md with comprehensive documentation
- Removed ROS2/colcon references
- Updated repository URLs to ansh1113
- Fixed usage examples for Python-first approach
- Added Quick Start section
- Added Docker usage instructions
- Added CI badge
- Corrected project structure to match actual files
- Enhanced .gitignore with comprehensive Python patterns
- Updated setup.py with proper package configuration

### Fixed
- Installation instructions now reflect actual setup process
- Project structure documentation matches repository layout
- All repository URLs point to correct GitHub location

## [0.1.0] - 2025-12-13

### Added
- Core motion planning module with ZMP constraints
- Support polygon computation and analysis
- Trajectory optimization with multiple objectives
- Forward and inverse kinematics solvers
- Stability analysis for humanoid robots
- Perception module for robot state estimation
- Configuration system using YAML files
- Example scripts for reaching tasks
- Comprehensive test suite
- Unit tests for all core modules
- Integration tests for planning pipeline
- Test coverage reporting
- Continuous Integration with GitHub Actions
- Multi-version Python testing (3.8, 3.9, 3.10, 3.11)
- Code linting with flake8
- Code formatting checks with black
- Test coverage with pytest-cov
- Docker image building
- Docker containerization for reproducible environments
- Example demonstrations
- Complete demo script (examples/complete_demo.py)
- Reaching task script (scripts/run_reaching_task.py)

### Performance
- 40% improvement in task success rate
- 15% reduction in trajectory execution time
- Zero ZMP violations in all tested scenarios
- ~2,000 lines of production-ready code

### Documentation
- Comprehensive README with usage examples
- Code documentation with docstrings
- Contributing guidelines (CONTRIBUTING.md)
- MIT License

## Project Milestones

### Phase 1: Core Implementation ✅
- Motion planner with ZMP constraints
- Basic kinematics and stability analysis
- Configuration system

### Phase 2: Testing & CI ✅
- Comprehensive test suite
- Continuous integration pipeline
- Code quality tools

### Phase 3: Documentation & Examples ✅
- Complete documentation suite
- Example scripts and demos
- Docker support

### Phase 4: Future Enhancements 🚧
- Dynamic walking capabilities
- Real-time replanning
- Multi-contact planning
- Learning-based initialization
- ROS2 integration

## Notes

### Known Limitations
- Planning time: 2-5 seconds (not real-time)
- Static stability only (no dynamic walking)
- Single contact scenario (feet on ground)
- No obstacle avoidance in current version

### Breaking Changes
None yet - this is the initial release.

### Migration Guide
N/A - Initial release.

---

## Version History

- **v0.1.0** (2025-12-13): Initial release with core motion planning features

---

## How to Contribute

See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on:
- Reporting bugs
- Suggesting enhancements
- Submitting pull requests
- Code style guidelines

---

## Contact

- **Author**: Ansh Bhansali
- **Email**: anshbhansali5@gmail.com
- **GitHub**: https://github.com/ansh1113/humanoid-motion-planning
- **Issues**: https://github.com/ansh1113/humanoid-motion-planning/issues

---

[Unreleased]: https://github.com/ansh1113/humanoid-motion-planning/compare/v0.1.0...HEAD
[0.1.0]: https://github.com/ansh1113/humanoid-motion-planning/releases/tag/v0.1.0
Loading
Loading