diff --git a/README.md b/README.md index ceb5035..0342105 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,15 @@ Check the [documentation](https://scene-synthesizer.github.io/) page for detaile This project will download and install additional third-party open source software projects. Review the license terms of these open source projects before use. +### Via pip ``` -# clone repository +pip install scene-synthesizer[recommend] +``` + +### Via git +``` +# create and activate conda env or venv +git clone https://github.com/NVlabs/scene_synthesizer.git cd scene_synthesizer/ pip install -e.[recommend] ``` diff --git a/docs/getting_started/install.rst b/docs/getting_started/install.rst index 33431c3..db0422f 100644 --- a/docs/getting_started/install.rst +++ b/docs/getting_started/install.rst @@ -4,13 +4,16 @@ Installation This project will download and install additional third-party open source software projects. Review the license terms of these open source projects before use. +There are two ways to install ``scene_synthesizer``: either directly installing from a PyPI server or by cloning the code repository. + +Via pip +======= + The most basic installation of ``scene_synthesizer`` will install as few dependencies as possible: .. code-block:: bash - # clone repository - cd scene_synthesizer/ - pip install -e . + pip install scene-synthesizer This allows you to load and export most common formats: STL, PLY, OBJ, GLB, GLTF, URDF. @@ -18,17 +21,30 @@ For importing and exporting USD files use the ``recommend`` pip extra: .. code-block:: bash - # clone repository - cd scene_synthesizer/ - pip install -e .[recommend] - + pip install scene-synthesizer[recommend] + If you want the full experience, you can try the ``all`` extra which includes all the functionality: .. code-block:: bash + + pip install scene-synthesizer[all] + +Via git +======= - # clone repository +Alternatively, if you want to make changes to ``scene_synthesizer``, clone the repository: + +.. code-block:: bash + + # create and activate conda env or venv + git clone https://github.com/NVlabs/scene_synthesizer.git cd scene_synthesizer/ - pip install -e .[all] + + # Again, there are the same three variations you can install: + # . + # .[recommend] + # .[all] + pip install -e . Soft Dependencies diff --git a/docs/index.rst b/docs/index.rst index 18a1447..7c3746e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -12,6 +12,7 @@ A Python package to easily create scenes for robot manipulation tasks. :maxdepth: 1 :caption: Getting Started + GitHub Repository getting_started/install.rst getting_started/faq.rst