.. _installation: ============ Installation ============ HoloOcean is installed in two portions: a client python library (``holoocean``) is installed first, which then downloads world packages. The python portion is very small, while the world packages ("binaries") can be several gigabytes. Requirements ============ - >= Python 3.7 - Several gigabytes of storage - pip3 - Linux or Windows 64bit - Preferably a competent GPU - For Linux: OpenGL 3+, gcc (minimum build-essential package) For the build-essential package for Linux, you can run the following console command: :: sudo apt install build-essential Stable Installation ===================== In accordance with the Unreal Engine EULA we can no longer offer HoloOcean through pypi. However, installing HoloOcean is still fairly simple, but requires a few more steps. First, follow the steps here to link your github account with Unreal: https://www.unrealengine.com/en-US/ue-on-github Note: The account web page may have been updated, currently the label for connections is named "Apps and Accounts". This requires you accept their EULA. .. raw:: html

Notice: Epic games is in the process of changing their github organization structure. If you've linked your account after June 10th and are on their mirror organization, the appropriate link is now github.com/byu-holoocean-mirror/HoloOcean and git clone is

:: git clone git@github.com:byu-holoocean-mirror/HoloOcean.git holoocean **Please let us know if you have any further issues.** Then, download or clone our repo at: https://github.com/byu-holoocean/HoloOcean **Note**: If you get a Page Not Found Error, it's because you didn't link your github account to your Epic Games account. Please refer to the previous paragraph, and link the accounts. We suggest cloning it with lowercase naming, as our example code uses, like so: :: git clone git@github.com:byu-holoocean/HoloOcean.git holoocean From the cloned repo, do the following: :: cd holoocean/client pip install . Then to install the most recent version of the oceans package, open a python shell by typing the following and hit enter :: python Then run the python command in that python shell :: import holoocean holoocean.install("Ocean") Or as a single console command, :: python -c `import holoocean; holoocean.install("Ocean")` .. note:: There is a bug on Windows with the package ``pywin32`` that occurs occasionally. If you see "ImportError: DLL load failed while importing win32event: The specified module could not be found.", it can be fixed by running ``pip install pywin32==225`` Beta Installation ========================== .. note:: If you had previously installed holoocean before moving to the develop or any other branch, then you will need to uninstall the binary by running ``holoocean.remove("Ocean")`` before proceeding. Failure to do so may result in unpredictable behavior. To install the develop branch, simply run :: git clone https://github.com/byu-holoocean/HoloOcean. cd holoocean/client git checkout develop pip install . Then to install the most recent version of the oceans package, run the python command :: import holoocean holoocean.install("Ocean", branch="develop") Or as a single console command, :: python -c `import holoocean; holoocean.install("Ocean", branch="develop")` Managing World Packages ======================= The ``holodeck`` python package includes a :ref:`packagemanager` that is used to download and install world packages. Below are some example usages, but see :ref:`packagemanager` for complete documentation. Install a Package Automatically ------------------------------- :: >>> from holoocean import packagemanager >>> packagemanager.installed_packages() [] >>> packagemanager.available_packages() ['Ocean'] >>> packagemanager.install("Ocean") Installing Ocean ver. 0.1.0 from https://robots.et.byu.edu/holo/Ocean/v0.1.0/Linux.zip File size: 1.55 GB |████████████████████████| 100% Unpacking worlds... Finished. >>> packagemanager.installed_packages() ['Ocean'] Installation Location --------------------- By default, HoloOcean will install packages local to your user profile. See :ref:`package-locations` for more information. Manually Installing a Package ----------------------------- To manually install a package, you will be provided a ``.zip`` file. Extract it into the ``worlds`` folder in your HoloOcean installation location (see :ref:`package-locations`) .. note:: Ensure that the file structure is as follows: :: + worlds +-- YourManuallyInstalledPackage | +-- config.json | +-- etc... +-- AnotherPackage | +-- config.json | +-- etc... Not :: + worlds +-- YourManuallyInstalledPackage | +-- YourManuallyInstalledPackage | +-- config.json | +-- etc... +-- AnotherPackage | +-- config.json | +-- etc... Print Information ----------------- There are several convenience functions provided to allow packages, worlds, and scenarios to be easily inspected. :: >>> packagemanager.package_info("Ocean") Package: Ocean Platform: Linux Version: 0.1.0 Path: LinuxNoEditor/Holodeck/Binaries/Linux/Holodeck Worlds: Rooms Scenarios: Rooms-DataGen: Agents: Name: turtle0 Type: TurtleAgent Sensors: LocationSensor lcm_channel: POSITION RotationSensor lcm_channel: ROTATION RangeFinderSensor lcm_channel: LIDAR configuration LaserCount: 64 LaserMaxDistance: 20 LaserAngle: 0 LaserDebug: True Rooms-IEKF: Agents: Name: uav0 Type: UavAgent Sensors: PoseSensor VelocitySensor IMUSensor SimpleUnderwater Scenarios: SimpleUnderwater-AUV: Agents: Name: auv0 Type: HoveringAUV Sensors: PoseSensor socket: IMUSocket VelocitySensor socket: IMUSocket IMUSensor socket: IMUSocket DVLSensor socket: DVLSocket You can also look for information for a specific world or scenario :: packagemanager.world_info("SimpleUnderwater") packagemanager.scenario_info("Rooms-DataGen")