Skip to content

Commit

Permalink
Doc changes.
Browse files Browse the repository at this point in the history
  • Loading branch information
0mdc committed Mar 16, 2023
1 parent 12a12d9 commit 5ce64b6
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 14 deletions.
19 changes: 7 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,18 +35,13 @@ https://user-images.githubusercontent.com/2941091/126080914-36dc8045-01d4-4a68-8
---

## Table of contents
- [Habitat-Sim](#habitat-sim)
- [Questions or Comments? Join the AI Habitat community discussions forum.](#questions-or-comments-join-the-ai-habitat-community-discussions-forum)
- [Table of contents](#table-of-contents)
- [Citing Habitat](#citing-habitat)
- [Installation](#installation)
- [\[Recommended\] Conda Packages](#recommended-conda-packages)
- [Testing](#testing)
- [Common testing issues](#common-testing-issues)
- [Documentation](#documentation)
- [Datasets](#datasets)
- [External Contributions](#external-contributions)
- [License](#license)
1. [Citing Habitat](#citing-habitat)
1. [Installation](#installation)
1. [Testing](#testing)
1. [Documentation](#documentation)
1. [Datasets](#datasets)
1. [External Contributions](#external-contributions)
1. [License](#license)


## Citing Habitat
Expand Down
4 changes: 2 additions & 2 deletions conda-build/README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
### Building for macOS

Install conda packages as described here ```conda-build/common/install_conda.sh``` and run ```conda create --name py39 python=3.9 -y;conda activate py39```.
Running ```python macos_matrix_builder.py``` with python >= 3.9 will start the build process by setting all the environment variables and making a call to conda build. Make sure the meta.yaml file in conda-build/habitat-sim/ is configured correctly according to https://docs.conda.io/projects/conda-build/en/latest/resources/define-metadata.html
Running ```python matrix_builder.py``` with python >= 3.9 will start the build process by setting all the environment variables and making a call to conda build. Make sure the meta.yaml file in conda-build/habitat-sim/ is configured correctly according to https://docs.conda.io/projects/conda-build/en/latest/resources/define-metadata.html

Once the package is built, make sure you're logged in to anaconda cloud and then run ```anaconda upload <path to the tarball file that conda build created>```. For example ```anaconda upload hsim-macos/osx-64/habitat-sim-1.3.2-py3.9_osx.tar.bz2```. This will upload the package to anaconda cloud for everyone to download.

Expand All @@ -18,7 +18,7 @@ That will create your docker container. Now run

```docker run -it --ipc=host --rm -v $(pwd)/../:/remote hsim_condabuild_dcontainer bash```

From there you will have a shell within your linux container. Now, navigate to ```cd /remote/conda-build``` where habitat-sim has been mounted. Create a conda environment within the linux container with python>=3.9 (identical to that needed by habitat-sim build): ```conda create --name py39 python=3.9;conda activate py39```. And then run ```python linux_matrix_builder.py```, which will kick off the build process. After this has finished, upload it to anaconda cloud in the same way described in the macOS section.
From there you will have a shell within your linux container. Now, navigate to ```cd /remote/conda-build``` where habitat-sim has been mounted. Create a conda environment within the linux container with python>=3.9 (identical to that needed by habitat-sim build): ```conda create --name py39 python=3.9;conda activate py39```. And then run ```python matrix_builder.py```, which will kick off the build process. After this has finished, upload it to anaconda cloud in the same way described in the macOS section.

To download the package, run ```conda install -c aihabitat -c conda-forge habitat-sim headless ```.

Expand Down

0 comments on commit 5ce64b6

Please sign in to comment.