Skip to content

Commit

Permalink
change references to habitat-sim "master" branch to "main" (#1481)
Browse files Browse the repository at this point in the history
  • Loading branch information
eundersander committed Sep 18, 2021
1 parent b7b00cb commit 61b3e72
Show file tree
Hide file tree
Showing 26 changed files with 69 additions and 69 deletions.
8 changes: 4 additions & 4 deletions .circleci/config.yml
Expand Up @@ -178,7 +178,7 @@ commands:
keys:
- ccache-{{ arch }}-{{ .Branch }}-{{ .BuildNum }}
- ccache-{{ arch }}-{{ .Branch }}-
- ccache-{{ arch }}-master-
- ccache-{{ arch }}-main-
paths:
- /home/circleci/.ccache
- run:
Expand Down Expand Up @@ -716,7 +716,7 @@ workflows:
cron: "0 7 * * *"
filters:
branches:
only: master
only: main
jobs:
- lab_build_habitat
- install_and_test_ubuntu
Expand All @@ -726,7 +726,7 @@ workflows:
- install_and_test_ubuntu
filters:
branches:
only: master
only: main
- build_conda_binaries:
AIHABITAT_CONDA_CHN: aihabitat-nightly
AIHABITAT_CONDA_CHN_PWD_VAR: AIHABITAT_NIGHTLY_CONDA_PWD
Expand All @@ -735,7 +735,7 @@ workflows:
- install_and_test_ubuntu
filters:
branches:
only: master
only: main

version_conda_release:
jobs:
Expand Down
6 changes: 3 additions & 3 deletions .github/ISSUE_TEMPLATE/bug-report.md
Expand Up @@ -5,11 +5,11 @@ about: Submit a bug report to help us improve Habitat
---

## Habitat-Sim version
vx.x.x or master?
vx.x.x or main?

Habitat is under active development, and we advise users to restrict themselves to stable releases. Are you using the latest [release version](https://github.com/facebookresearch/habitat-sim/releases) of Habitat-Sim? The bug you are about to report may already be fixed in the latest version.

Master branch contains 'bleeding edge' code, but we do appreciate bug reports for it!
Main branch contains 'bleeding edge' code, but we do appreciate bug reports for it!

## 🐛 Bug

Expand Down Expand Up @@ -40,7 +40,7 @@ Steps to reproduce the behavior:
## System Info

Please copy and paste the output from the
[environment collection script](https://github.com/facebookresearch/habitat-sim/tree/master/habitat_sim/utils/collect_env.py)
[environment collection script](https://github.com/facebookresearch/habitat-sim/tree/main/habitat_sim/utils/collect_env.py)
(or fill out the checklist below manually).

You can run the script with:
Expand Down
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/questions-help-support.md
Expand Up @@ -9,7 +9,7 @@ vx.x.x

Habitat is under active development, and we advise users to restrict themselves to stable releases. Are you using the latest [release version](https://github.com/facebookresearch/habitat-sim/releases) of Habitat-Sim? Your question may already be addressed in the latest version. We may also not be able to help with problems in earlier versions because they sometimes lack the more verbose logging needed for debugging.

Master branch contains 'bleeding edge' code and should be used at your own risk.
Main branch contains 'bleeding edge' code and should be used at your own risk.

## Docs and Tutorials
Did you read the docs? https://aihabitat.org/docs/habitat-sim/
Expand Down
6 changes: 3 additions & 3 deletions BUILD_FROM_SOURCE.md
Expand Up @@ -10,7 +10,7 @@
```

- You can also allow pip to compile a specific version of Habitat. First clone the repo, then `pip install .` in the current git root directory
to start the compilation process. To quickly compile the latest master, run `pip install git+https://github.com/facebookresearch/habitat-sim`.
to start the compilation process. To quickly compile the latest main, run `pip install git+https://github.com/facebookresearch/habitat-sim`.

- Since pip out of tree by default, this process will copy quite a lot of data to your TMPDIR. You can change this location by modifying the TMPDIR env variable.
It will also not cache previous builds effectively and therefore will be slow. For active develeopment, building using `python setup.py install...` is recommended.
Expand All @@ -33,7 +33,7 @@ We highly recommend installing a [miniconda](https://docs.conda.io/en/latest/min
cd habitat-sim
```

List of stable releases is [available here](https://github.com/facebookresearch/habitat-sim/releases). Master branch contains 'bleeding edge' code and under active development.
List of stable releases is [available here](https://github.com/facebookresearch/habitat-sim/releases). Main branch contains 'bleeding edge' code and under active development.

1. Install Dependencies

Expand All @@ -56,7 +56,7 @@ We highly recommend installing a [miniconda](https://docs.conda.io/en/latest/min
libjpeg-dev libglm-dev libgl1-mesa-glx libegl1-mesa-dev mesa-utils xorg-dev freeglut3-dev
```

See this [configuration for a full list of dependencies](https://github.com/facebookresearch/habitat-sim/blob/master/.circleci/config.yml#L64) that our CI installs on a clean Ubuntu VM. If you run into build errors later, this is a good place to check if all dependencies are installed.
See this [configuration for a full list of dependencies](https://github.com/facebookresearch/habitat-sim/blob/main/.circleci/config.yml#L64) that our CI installs on a clean Ubuntu VM. If you run into build errors later, this is a good place to check if all dependencies are installed.

1. Build Habitat-Sim

Expand Down
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
Expand Up @@ -9,18 +9,18 @@ possible.
- Try to make small, logically independent, self-documenting commits (and reflect this in the commit messages by providing brief rationale/change summary).
- We encourage creating draft PRs to gather early feedback.
- Request reviews from at least one Habitat core team member (if the scope of changes necessitates, request from two or more reviewers).
- We have adopted squash-and-merge as the policy for incorporating PRs into the master branch. We encourage more smaller/focused PRs rather than big PRs with many independent changes. This also enables faster development by merging PRs into master quickly and reducing the need to rebase due to changes on master.
- While working on a PR, try to religiously keep your fork up-to-date with master by rebasing as necessary. Note that the above recommendation for smaller and more frequent PRs reduces the burden of rebasing.
- We have adopted squash-and-merge as the policy for incorporating PRs into the main branch. We encourage more smaller/focused PRs rather than big PRs with many independent changes. This also enables faster development by merging PRs into main quickly and reducing the need to rebase due to changes on main.
- While working on a PR, try to religiously keep your fork up-to-date with main by rebasing as necessary. Note that the above recommendation for smaller and more frequent PRs reduces the burden of rebasing.
- We expect PR ready for final review only if Continuous Integration tests are passing.
- Recommended: after getting a PR through reviews/feedback and is merged into master, delete the branch to de-clutter noise.
- Recommended: after getting a PR through reviews/feedback and is merged into main, delete the branch to de-clutter noise.
- Reach out to us with questions or suggestions on our Slack channel.

## Contributor License Agreement ("CLA")
In order to accept your pull request, we need you to submit a CLA. You only need
to do this once to work on any of Facebook's open source projects. Complete your CLA [here](https://code.facebook.com/cla).

By contributing to habitat-sim, you agree that your contributions will be licensed
under [the LICENSE file](https://github.com/facebookresearch/habitat-sim/blob/master/LICENSE).
under [the LICENSE file](https://github.com/facebookresearch/habitat-sim/blob/main/LICENSE).

## Versioning / release workflow
We use [semantic versioning](https://semver.org/). To prepare a release:
Expand Down
6 changes: 3 additions & 3 deletions README.md
@@ -1,6 +1,6 @@
[![CircleCI](https://circleci.com/gh/facebookresearch/habitat-sim.svg?style=shield)](https://circleci.com/gh/facebookresearch/habitat-sim)
[![codecov](https://codecov.io/gh/facebookresearch/habitat-sim/branch/master/graph/badge.svg)](https://codecov.io/gh/facebookresearch/habitat-sim)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/facebookresearch/habitat-sim/blob/master/LICENSE)
[![codecov](https://codecov.io/gh/facebookresearch/habitat-sim/branch/main/graph/badge.svg)](https://codecov.io/gh/facebookresearch/habitat-sim)
[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/facebookresearch/habitat-sim/blob/main/LICENSE)
[![Conda Version Badge](https://img.shields.io/conda/vn/aihabitat/habitat-sim?color=blue&label=conda%20version)](https://anaconda.org/aihabitat/habitat-sim)
[![Conda Platforms support Badge](https://img.shields.io/conda/pn/aihabitat/habitat-sim?color=orange&label=platforms)](https://anaconda.org/aihabitat/habitat-sim)
[![Documentation](https://img.shields.io/badge/docs-automated-green.svg)](https://aihabitat.org/docs/habitat-sim/)
Expand Down Expand Up @@ -109,7 +109,7 @@ Pick one of the options below depending on your system/needs:

Conda packages for older versions can installed by explicitly specifying the version, e.g. `conda install habitat-sim=0.1.6 -c conda-forge -c aihabitat`.

We also provide a [nightly conda build for the master branch](https://anaconda.org/aihabitat-nightly). However, this should only be used if you need a specific feature not yet in the latest release version. To get the nightly build of the latest master, simply swap `-c aihabitat` for `-c aihabitat-nightly`.
We also provide a [nightly conda build for the main branch](https://anaconda.org/aihabitat-nightly). However, this should only be used if you need a specific feature not yet in the latest release version. To get the nightly build of the latest main, simply swap `-c aihabitat` for `-c aihabitat-nightly`.

## Testing

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/asset-viewer-tutorial.rst
Expand Up @@ -16,7 +16,7 @@ View Assets in Habitat-Sim
When composing or editing assets for a habitat dataset, it would be helpful to see how they would be rendered in the Habitat-sim engine. This can be difficult to accomplish without a lot of setup work, and this is made more difficult if Habitat-sim is not installed.
This tutorial describes the Asset Viewer tool, which exists as both a `Collab`_, and a pure python utility.

.. _Collab: <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/master/examples/tutorials/colabs/asset_viewer.ipynb>
.. _Collab: <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/main/examples/tutorials/colabs/asset_viewer.ipynb>

.. code:: shell-session
Expand Down
4 changes: 2 additions & 2 deletions docs/pages/image-extractor.rst
Expand Up @@ -601,6 +601,6 @@ events happen:
Thank you for reading!


.. _this code: https://github.com/facebookresearch/habitat-sim/blob/master/habitat_sim/utils/data/pose_extractor.py
.. _this code: https://github.com/facebookresearch/habitat-sim/blob/main/habitat_sim/utils/data/pose_extractor.py

.. _Habitat-Sim Basics for Navigation Colab notebook: https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/master/examples/tutorials/colabs/ECCV_2020_Navigation.ipynb
.. _Habitat-Sim Basics for Navigation Colab notebook: https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/main/examples/tutorials/colabs/ECCV_2020_Navigation.ipynb
38 changes: 19 additions & 19 deletions docs/pages/index.rst
Expand Up @@ -17,11 +17,11 @@ Tutorials
.. class:: m-table m-fullwidth

=================================================== ========================================================================================================================================================== ======================
Basics for Navigation `Video <https://youtu.be/kunFMRJAu2U?list=PLGywud_-HlCORC0c4uj97oppQrGiB6JNy>`__ `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/master/examples/tutorials/colabs/ECCV_2020_Navigation.ipynb>`__
Basics for Navigation `Video <https://youtu.be/kunFMRJAu2U?list=PLGywud_-HlCORC0c4uj97oppQrGiB6JNy>`__ `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/main/examples/tutorials/colabs/ECCV_2020_Navigation.ipynb>`__

Interaction `Video <https://youtu.be/6eh0PBesIgw?list=PLGywud_-HlCORC0c4uj97oppQrGiB6JNy>`__ `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/master/examples/tutorials/colabs/ECCV_2020_Interactivity.ipynb>`__
Interaction `Video <https://youtu.be/6eh0PBesIgw?list=PLGywud_-HlCORC0c4uj97oppQrGiB6JNy>`__ `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/main/examples/tutorials/colabs/ECCV_2020_Interactivity.ipynb>`__

Advanced Topics `Video <https://youtu.be/w_kDq6UOKos?list=PLGywud_-HlCORC0c4uj97oppQrGiB6JNy>`__ `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/master/examples/tutorials/colabs/ECCV_2020_Advanced_Features.ipynb>`__
Advanced Topics `Video <https://youtu.be/w_kDq6UOKos?list=PLGywud_-HlCORC0c4uj97oppQrGiB6JNy>`__ `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/main/examples/tutorials/colabs/ECCV_2020_Advanced_Features.ipynb>`__

Profiling and Optimization `Video <https://youtu.be/I4MjX598ZYs?list=PLGywud_-HlCORC0c4uj97oppQrGiB6JNy>`__ `Interactive Colab <https://colab.research.google.com/gist/eundersander/b62bb497519b44cf4ceb10e2079525dc/faster-rl-training-profiling-and-optimization.ipynb>`__

Expand All @@ -35,11 +35,11 @@ Working with light setups :ref:`Page <std:doc:lighting

Extracting Images :ref:`Page <std:doc:image-extractor>`

View Assets in Habitat-Sim :ref:`Page <std:doc:asset-viewer-tutorial>` `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/master/examples/tutorials/colabs/asset_viewer.ipynb>`__
View Assets in Habitat-Sim :ref:`Page <std:doc:asset-viewer-tutorial>` `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/main/examples/tutorials/colabs/asset_viewer.ipynb>`__

Interactive Rigid Objects 2.0 :ref:`Page <std:doc:managed-rigid-object-tutorial>` `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/master/examples/tutorials/colabs/managed_rigid_object_tutorial.ipynb>`__
Interactive Rigid Objects 2.0 :ref:`Page <std:doc:managed-rigid-object-tutorial>` `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/main/examples/tutorials/colabs/managed_rigid_object_tutorial.ipynb>`__

Gfx Replay `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/master/examples/tutorials/colabs/replay_tutorial.ipynb>`__
Gfx Replay `Interactive Colab <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/main/examples/tutorials/colabs/replay_tutorial.ipynb>`__

Editing Scene Assets in Blender `Page <https://aihabitat.org/tutorial/editing_in_blender/>`_
=================================================== ========================================================================================================================================================== ======================
Expand All @@ -59,19 +59,19 @@ Python Unit Tests

Browse selected unit tests that demonstrate essential *Habitat-Sim* interfaces.

- :gh:`test_agent.py <facebookresearch/habitat-sim/blob/master/tests/test_agent.py>`
- :gh:`test_attributes_managers.py <facebookresearch/habitat-sim/blob/master/tests/test_attributes_managers.py>`
- :gh:`test_configs.py <facebookresearch/habitat-sim/blob/master/tests/test_configs.py>`
- :gh:`test_controls.py <facebookresearch/habitat-sim/blob/master/tests/test_controls.py>`
- :gh:`test_gfx.py <facebookresearch/habitat-sim/blob/master/tests/test_gfx.py>`
- :gh:`test_greedy_follower.py <facebookresearch/habitat-sim/blob/master/tests/test_greedy_follower.py>`
- :gh:`test_light_setup.py <facebookresearch/habitat-sim/blob/master/tests/test_light_setup.py>`
- :gh:`test_navmesh.py <facebookresearch/habitat-sim/blob/master/tests/test_navmesh.py>`
- :gh:`test_physics.py <facebookresearch/habitat-sim/blob/master/tests/test_physics.py>`
- :gh:`test_pyrobot_noisy_controls.py <facebookresearch/habitat-sim/blob/master/tests/test_pyrobot_noisy_controls.py>`
- :gh:`test_semantic_scene.py <facebookresearch/habitat-sim/blob/master/tests/test_semantic_scene.py>`
- :gh:`test_sensors.py <facebookresearch/habitat-sim/blob/master/tests/test_sensors.py>`
- :gh:`test_simulator.py <facebookresearch/habitat-sim/blob/master/tests/test_simulator.py>`
- :gh:`test_agent.py <facebookresearch/habitat-sim/blob/main/tests/test_agent.py>`
- :gh:`test_attributes_managers.py <facebookresearch/habitat-sim/blob/main/tests/test_attributes_managers.py>`
- :gh:`test_configs.py <facebookresearch/habitat-sim/blob/main/tests/test_configs.py>`
- :gh:`test_controls.py <facebookresearch/habitat-sim/blob/main/tests/test_controls.py>`
- :gh:`test_gfx.py <facebookresearch/habitat-sim/blob/main/tests/test_gfx.py>`
- :gh:`test_greedy_follower.py <facebookresearch/habitat-sim/blob/main/tests/test_greedy_follower.py>`
- :gh:`test_light_setup.py <facebookresearch/habitat-sim/blob/main/tests/test_light_setup.py>`
- :gh:`test_navmesh.py <facebookresearch/habitat-sim/blob/main/tests/test_navmesh.py>`
- :gh:`test_physics.py <facebookresearch/habitat-sim/blob/main/tests/test_physics.py>`
- :gh:`test_pyrobot_noisy_controls.py <facebookresearch/habitat-sim/blob/main/tests/test_pyrobot_noisy_controls.py>`
- :gh:`test_semantic_scene.py <facebookresearch/habitat-sim/blob/main/tests/test_semantic_scene.py>`
- :gh:`test_sensors.py <facebookresearch/habitat-sim/blob/main/tests/test_sensors.py>`
- :gh:`test_simulator.py <facebookresearch/habitat-sim/blob/main/tests/test_simulator.py>`

.. We exclude unit tests that aren't particularly self-explanatory or interesting.
.. test_snap_points
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/managed-rigid-object-tutorial.rst
Expand Up @@ -15,7 +15,7 @@ Interactive Rigid Objects via PhysicsObjectManager

The example code below is available on `Collab`_, or runnable via:

.. _Collab: <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/master/examples/tutorials/colabs/managed_rigid_object_tutorial.ipynb>
.. _Collab: <https://colab.research.google.com/github/facebookresearch/habitat-sim/blob/main/examples/tutorials/colabs/managed_rigid_object_tutorial.ipynb>

.. code:: shell-session
Expand Down

0 comments on commit 61b3e72

Please sign in to comment.