https://github.com/amazon-science/fleet2d
Fleet2D: A lightweight, 2D simulator for fast, long-term, consumer robotics applications.
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.8%) to scientific vocabulary
Keywords
Repository
Fleet2D: A lightweight, 2D simulator for fast, long-term, consumer robotics applications.
Basic Info
- Host: GitHub
- Owner: amazon-science
- License: apache-2.0
- Language: Python
- Default Branch: main
- Homepage: https://github.com/amazon-science/fleet2d/
- Size: 49.8 KB
Statistics
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
Fleet2D
Fleet2D is a simulation framework for testing long time-horizon algorithms.
Running locally
To run Fleet2D use the following steps.
Set up
To install Python dependencies locally run the following command:
pip3 install -r requirements.txt
Prerequisites
Fleet2D depends on an OpenCV installation that supports both Python and C++ development. The easiest way to achieve this is usually by installing the Python OpenCV libraries (via the requirements.txt installation above. And then installing the same corresponding OpenCV version using your system's package manager.
For example, currently the requirement is opencv-python~=4.6.0, then using your distribution's package manager (e.g. apt, yum, brew, etc) specify version 4.6.0 of OpenCV's C++ development libraries.
Another method might be to simply build and install OpenCV from source. We've found this to be the most straightforward on MacOS.
Build
To build locally run the following command:
python3 setup.py build
Once the command has completed compiling any C++ files that have been updated, a build directory is created. Usually this is the build directory in the package's root. Navigate to this directory with the following command:
cd build/lib\*
Once there, export the path for Python to be able to recognize the freshly built library:
export PYTHONPATH=`pwd`
Then go back to your original workspace directory (cd - should work). You're now ready to run the simulator!
Run simulation
To run the simulation using the config file located at src/f2d/configs/config_simple.yaml enter the following command from the package home directory:
python3 src/f2d/simulation/simulation.py src/f2d/configs/config_simple.yaml
Development iteration
Once set up, a typical build/run command after each code change might look like
python3 setup.py build && python3 src/f2d/simulation/simulation.py src/f2d/configs/config_simple.yaml
Or, the command could be set up in PyCharm by editing the runtime configuration and adding the appropriate path/command there.
Security
See CONTRIBUTING for more information.
License
This project is licensed under the Apache-2.0 License.
Owner
- Name: Amazon Science
- Login: amazon-science
- Kind: organization
- Website: https://amazon.science
- Twitter: AmazonScience
- Repositories: 80
- Profile: https://github.com/amazon-science
GitHub Events
Total
- Watch event: 1
Last Year
- Watch event: 1
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| Hamid Badiozamani | 3****m | 2 |
| Amazon GitHub Automation | 5****o | 1 |
Issues and Pull Requests
Last synced: 11 months ago
All Time
- Total issues: 0
- Total pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: about 10 hours
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 2
- Average time to close issues: N/A
- Average time to close pull requests: about 16 hours
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 2
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- badiozam (5)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- PyYAML *
- matplotlib *
- mpmath *
- numpy *
- opencv-python *
- pathos *
- pytest *
- pytest-cov *
- scikit-image *
- setuptools *
- sortedcontainers *
- tqdm *