Skip to content

Commit e05a357

Browse files
committed
adds initial files
1 parent 7ec9a24 commit e05a357

File tree

296 files changed

+40320
-2
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

296 files changed

+40320
-2
lines changed

.flake8

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
[flake8]
2+
show-source=True
3+
statistics=True
4+
per-file-ignores=*/__init__.py:F401
5+
ignore=E402,E501,W503,E203
6+
max-line-length = 120
7+
max-complexity = 30
8+
exclude=_*,.vscode,.git

.github/ISSUE_TEMPLATE/bug.md

+47
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
name: Bug Report
3+
about: Submit a bug report
4+
title: "[Bug Report] Bug title"
5+
6+
---
7+
8+
If you are submitting a bug report, please fill in the following details and use the tag [bug].
9+
10+
### Describe the bug
11+
12+
A clear and concise description of what the bug is.
13+
14+
### Steps to reproduce
15+
16+
Please try to provide a minimal example to reproduce the bug. Error messages and stack traces are also helpful.
17+
18+
<!-- Please post terminal logs, minimal example to reproduce, or command to run under three backticks (```) to allow code formatting.
19+
20+
```
21+
Paste your error here
22+
```
23+
24+
For more information on this, check: https://www.markdownguide.org/extended-syntax/#fenced-code-blocks
25+
26+
-->
27+
28+
### System Info
29+
30+
Describe the characteristic of your environment:
31+
32+
<!-- Please complete the following description. -->
33+
- Commit: [e.g. 8f3b9ca]
34+
- Isaac Sim Version: [e.g. 2022.2.0, this can be obtained by `cat ${ISAACSIM_PATH}/VERSION`]
35+
- OS: [e.g. Ubuntu 20.04]
36+
- GPU: [e.g. RTX 2060 Super]
37+
- CUDA: [e.g. 11.4]
38+
- GPU Driver: [e.g. 470.82.01, this can be seen by using `nvidia-smi` command.]
39+
40+
### Additional context
41+
42+
Add any other context about the problem here.
43+
44+
### Checklist
45+
46+
- [ ] I have checked that there is no similar issue in the repo (**required**)
47+
- [ ] I have checked that the issue is not in running Isaac Sim itself and is related to the repo

.github/ISSUE_TEMPLATE/proposal.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
name: Proposal
3+
about: Propose changes that are not fixes bugs
4+
title: "[Proposal] Proposal title"
5+
---
6+
7+
8+
### Proposal
9+
10+
A clear and concise description of the proposal. In a few sentences, describe the feature and its core capabilities.
11+
12+
### Motivation
13+
14+
Please outline the motivation for the proposal. Summarize the core use cases and user problems and needs you are trying to solve.
15+
16+
Is your feature request related to a problem? e.g.,"I'm always frustrated when [...]".
17+
18+
If this is related to another GitHub issue, please link here too.
19+
20+
### Pitch
21+
22+
A clear and concise description of what you want to happen.
23+
24+
### Alternatives
25+
26+
A clear and concise description of any alternative solutions or features you've considered, if any.
27+
28+
### Additional context
29+
30+
Add any other context or screenshots about the feature request here.
31+
32+
### Checklist
33+
34+
- [ ] I have checked that there is no similar issue in the repo (**required**)

.github/ISSUE_TEMPLATE/question.md

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
---
2+
name: Question
3+
about: Ask a question
4+
title: "[Question] Question title"
5+
---
6+
7+
### Question
8+
9+
Basic questions, related to robot learning, that are not bugs or feature requests will be closed without reply, because GitHub issues are not an appropriate venue for these.
10+
11+
Advanced/nontrivial questions, especially in areas where documentation is lacking, are very much welcome.
12+
13+
For questions that are related to running and understanding Isaac Sim, please post them at the official [Isaac Sim forums](https://docs.omniverse.nvidia.com/app_isaacsim/app_isaacsim/isaac_sim_forums.html).

.github/LICENSE_HEADER.txt

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
Copyright (c) 2022, NVIDIA CORPORATION & AFFILIATES, ETH Zurich, and University of Toronto
2+
All rights reserved.
3+
4+
SPDX-License-Identifier: BSD-3-Clause

.github/PULL_REQUEST_TEMPLATE.md

+55
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Description
2+
3+
<!--
4+
Thank you for your interest in sending a pull request. Please make sure to check the contribution guidelines.
5+
6+
Link: https://isaac-orbit.github.io/orbit/source/refs/contributing.html
7+
-->
8+
9+
Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context.
10+
List any dependencies that are required for this change.
11+
12+
Fixes # (issue)
13+
14+
<!-- As a practice, it is recommended to open an issue to have discussions on the proposed pull request.
15+
This makes it easier for the community to keep track of what is being developed or added, and if a given feature
16+
is demanded by more than one party. -->
17+
18+
## Type of change
19+
20+
<!-- As you go through the list, delete the ones that are not applicable. -->
21+
22+
- Bug fix (non-breaking change which fixes an issue)
23+
- New feature (non-breaking change which adds functionality)
24+
- Breaking change (fix or feature that would cause existing functionality to not work as expected)
25+
- This change requires a documentation update
26+
27+
## Screenshots
28+
29+
Please attach before and after screenshots of the change if applicable.
30+
31+
<!--
32+
Example:
33+
34+
| Before | After |
35+
| ------ | ----- |
36+
| _gif/png before_ | _gif/png after_ |
37+
38+
To upload images to a PR -- simply drag and drop an image while in edit mode and it should upload the image directly. You can then paste that source into the above before/after sections.
39+
-->
40+
41+
## Checklist
42+
43+
- [ ] I have run the [`pre-commit` checks](https://pre-commit.com/) with `pre-commit run --all-files` (see [here](https://pre-commit.com/#install) instructions to set it up)
44+
- [ ] I have made corresponding changes to the documentation
45+
- [ ] My changes generate no new warnings
46+
- [ ] I have added tests that prove my fix is effective or that my feature works
47+
- [ ] I have updated the changelog and the corresponding version in the extension's `setup.py` and `config/extension.toml` files
48+
49+
<!--
50+
As you go through the checklist above, you can mark something as done by putting an x character in it
51+
52+
For example,
53+
- [x] I have done this task
54+
- [ ] I have not done this task
55+
-->

.github/stale.yml

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# Configuration for probot-stale - https://github.com/probot/stale
2+
3+
# Number of days of inactivity before an Issue or Pull Request becomes stale
4+
daysUntilStale: 60
5+
6+
# Number of days of inactivity before an Issue or Pull Request with the stale label is closed.
7+
# Set to false to disable. If disabled, issues still need to be closed manually, but will remain marked as stale.
8+
daysUntilClose: 14
9+
10+
# Only issues or pull requests with all of these labels are check if stale. Defaults to `[]` (disabled)
11+
onlyLabels:
12+
- more-information-needed
13+
14+
# Issues or Pull Requests with these labels will never be considered stale. Set to `[]` to disable
15+
exemptLabels:
16+
- pinned
17+
- security
18+
- "[Status] Maybe Later"
19+
20+
# Set to true to ignore issues in a project (defaults to false)
21+
exemptProjects: true
22+
23+
# Set to true to ignore issues in a milestone (defaults to false)
24+
exemptMilestones: true
25+
26+
# Set to true to ignore issues with an assignee (defaults to false)
27+
exemptAssignees: true
28+
29+
# Label to use when marking as stale
30+
staleLabel: stale
31+
32+
# Comment to post when marking as stale. Set to `false` to disable
33+
markComment: >
34+
This issue has been automatically marked as stale because it has not had
35+
recent activity. It will be closed if no further activity occurs. Thank you
36+
for your contributions.
37+
38+
# Comment to post when removing the stale label.
39+
# unmarkComment: >
40+
# Your comment here.
41+
42+
# Comment to post when closing a stale Issue or Pull Request.
43+
# closeComment: >
44+
# Your comment here.
45+
46+
# Limit the number of actions per hour, from 1-30. Default is 30
47+
limitPerRun: 30
48+
49+
# Limit to only `issues` or `pulls`
50+
only: issues
51+
52+
# Optionally, specify configuration settings that are specific to just 'issues' or 'pulls':
53+
# pulls:
54+
# daysUntilStale: 30
55+
# markComment: >
56+
# This pull request has been automatically marked as stale because it has not had
57+
# recent activity. It will be closed if no further activity occurs. Thank you
58+
# for your contributions.
59+
60+
# issues:
61+
# exemptLabels:
62+
# - confirmed

.github/workflows/docs.yaml

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
name: Build & deploy docs
2+
3+
on: [push]
4+
5+
jobs:
6+
build-docs:
7+
name: Build and deploy documentation
8+
runs-on: ubuntu-latest
9+
if: github.repository == 'Isaac-Orbit/orbit' && github.ref == 'refs/heads/main'
10+
11+
steps:
12+
- name: Checkout code
13+
uses: actions/checkout@v2
14+
15+
- name: Setup python
16+
uses: actions/setup-python@v2
17+
with:
18+
python-version: "3.8"
19+
architecture: x64
20+
21+
- name: Install dev requirements
22+
working-directory: ./docs
23+
run: pip install -r requirements.txt
24+
25+
- name: Generate docs
26+
working-directory: ./docs
27+
run: make html
28+
29+
- name: Deploy to gh-pages
30+
uses: peaceiris/actions-gh-pages@v3
31+
with:
32+
github_token: ${{ secrets.GITHUB_TOKEN }}
33+
publish_dir: ./docs/_build/html

.github/workflows/pre-commit.yaml

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
name: Run linters using pre-commit
2+
3+
on:
4+
pull_request:
5+
push:
6+
branches: [main]
7+
8+
jobs:
9+
pre-commit:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- uses: actions/checkout@v3
13+
- uses: actions/setup-python@v3
14+
- uses: pre-commit/[email protected]

.gitignore

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# C++
2+
**/cmake-build*/
3+
**/build*/
4+
**/*.so
5+
6+
# Omniverse
7+
**/*.dmp
8+
**/.thumbs
9+
10+
# Python
11+
.DS_Store
12+
**/*.egg-info/
13+
**/__pycache__/
14+
**/.pytest_cache/
15+
**/*.pyc
16+
**/*.pb
17+
18+
# IDE
19+
**/.idea/
20+
**/.vscode/.**
21+
22+
# Outputs
23+
**/output/*
24+
*.tmp
25+
26+
# Isaac-Sim packman
27+
_isaac_sim
28+
_repo
29+
_build
30+
.lastformat
31+
32+
# Internal
33+
# TODO: Remove this once we have a better way to handle internal files.
34+
source/extensions/omni.isaac.assets
35+
36+
# RL-Games
37+
**/runs/*
38+
**/logs/*

.pre-commit-config.yaml

+46
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
repos:
2+
- repo: https://github.com/python/black
3+
rev: 22.10.0
4+
hooks:
5+
- id: black
6+
args: ["--line-length", "120"]
7+
- repo: https://github.com/pycqa/flake8
8+
rev: 6.0.0
9+
hooks:
10+
- id: flake8
11+
- repo: https://github.com/pre-commit/pre-commit-hooks
12+
rev: v4.4.0
13+
hooks:
14+
- id: trailing-whitespace
15+
- id: check-yaml
16+
- id: check-merge-conflict
17+
- id: check-case-conflict
18+
- id: check-executables-have-shebangs
19+
- id: check-toml
20+
- id: end-of-file-fixer
21+
- repo: https://github.com/pycqa/isort
22+
rev: 5.10.1
23+
hooks:
24+
- id: isort
25+
name: isort (python)
26+
args: ["--profile", "black", "--filter-files"]
27+
- repo: https://github.com/asottile/pyupgrade
28+
rev: v3.3.0
29+
hooks:
30+
- id: pyupgrade
31+
args: ["--py37-plus"]
32+
# FIXME: Figure out why this is getting stuck under VPN.
33+
# - repo: https://github.com/RobertCraigie/pyright-python
34+
# rev: v1.1.282
35+
# hooks:
36+
# - id: pyright
37+
# Note: We disable this by default since not all code is compatible with it.
38+
# - repo: https://github.com/Lucas-C/pre-commit-hooks
39+
# rev: v1.3.1
40+
# hooks:
41+
# - id: insert-license
42+
# files: \.py$
43+
# args:
44+
# # - --remove-header # Remove existing license headers. Useful when updating license.
45+
# - --license-filepath
46+
# - .github/LICENSE_HEADER.txt

.vscode/extensions.json

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
{
2+
// See http://go.microsoft.com/fwlink/?LinkId=827846
3+
// for the documentation about the extensions.json format
4+
"recommendations": [
5+
"ms-vscode.cpptools",
6+
"ms-python.python",
7+
"ms-python.vscode-pylance",
8+
"ban.spellright",
9+
"ms-iot.vscode-ros",
10+
"ExecutableBookProject.myst-highlight",
11+
]
12+
}

0 commit comments

Comments
 (0)