From 548a1c34d547c7ed64ac09233bf92dd35398e2fb Mon Sep 17 00:00:00 2001 From: han16nah Date: Wed, 18 Oct 2023 16:59:03 +0200 Subject: [PATCH 1/3] update wiki --- wiki-repo/helios.wiki | 2 +- wiki-repo/mkdocs.yml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/wiki-repo/helios.wiki b/wiki-repo/helios.wiki index 23a16a931..4e4d2c4b2 160000 --- a/wiki-repo/helios.wiki +++ b/wiki-repo/helios.wiki @@ -1 +1 @@ -Subproject commit 23a16a9318d73e5ae0b90647d9f5dd349adbfb91 +Subproject commit 4e4d2c4b236da3b04aa6918f16a1683b79553fed diff --git a/wiki-repo/mkdocs.yml b/wiki-repo/mkdocs.yml index 76662ab3c..b0436a72f 100644 --- a/wiki-repo/mkdocs.yml +++ b/wiki-repo/mkdocs.yml @@ -31,6 +31,7 @@ nav: - 'XML definitions': - 'Survey': 'Survey.md' - 'Scene': 'Scene.md' + - 'Dynamic scene': 'Dynamic-scenes.md' - 'Scanner': 'Scanners.md' - 'Platform': 'Platforms.md' - 'Random errors': 'Error-sources-and-randomness-control.md' @@ -45,7 +46,6 @@ nav: - 'Scene generation - external tools': 'Supplementary-tools-for-scene-generation.md' - 'Visualising the simulation': 'Visualising-the-simulation.md' - 'Tutorial videos': 'Tutorial-videos.md' - - 'Beta: Dynamic scenes': 'Dynamic-scenes.md' - 'Change log': 'Change-log.md' - 'References': - 'Research using HELIOS': 'Research-using-HELIOS.md' From bb5fd74f96a1e06089cfd3a34555815684d42dc2 Mon Sep 17 00:00:00 2001 From: han16nah <41050948+han16nah@users.noreply.github.com> Date: Wed, 18 Oct 2023 17:01:46 +0200 Subject: [PATCH 2/3] Update BUILDME.md remove "Usage" section, so it does not have to maintained in several places --- BUILDME.md | 100 ++--------------------------------------------------- 1 file changed, 3 insertions(+), 97 deletions(-) diff --git a/BUILDME.md b/BUILDME.md index a29231dc9..76d85ae6c 100644 --- a/BUILDME.md +++ b/BUILDME.md @@ -2,15 +2,14 @@ ## Table of contents 1. [Legacy version](#legacy-version) -1. [Install](#install) +2. [Install](#install) 1. [Dependencies](#dependencies) 2. [Install on Linux](#install-on-linux) 3. [Install on Linux with PyHelios Support](#install-on-linux-with-pyhelios-support) 4. [Install on Linux with Visual Debug](#install-on-linux-with-visual-debug) 5. [Install on Windows](#install-on-windows) -1. [Building the Wiki](#wiki) -1. [Usage](#usage) -1. [License](#license) +3. [Building the Wiki](#wiki) +4. [License](#license) ## Legacy version HELIOS, the predecessor of HELIOS++, can still be found at https://github.com/GIScience/helios @@ -489,99 +488,6 @@ And run mkdocs (you may need to install it and any required packages using `pip` The local wiki build is then generated in the `site` subdirectory. ---- -## Usage -Helios++ can be invoked with following syntax: - -``` -helios --help - Show the help for helios++ usage - -helios --test - Perform necessary tests to check everything works as expected - -helios [OPTIONAL ARGUMENTS] - Perform requested simulation. - - NOTICE specifying the path to the survey specification file is mandatory - - Available general OPTIONAL ARGUMENTS are: - --assets - Specify the path to assets directory - --output - Specify the path to output directory - --writeWaveform - Specify the full waveform must be written - --calcEchowidth - Specify the full waveform must be fitted - --fullwaveNoise - Enable random noise at full waveform computation - --fixedIncidenceAngle - Sets incidence angle to exactly 1.0 for all intersections - --seed - Specify the seed to be used for randomness generation. - The seed can be an integer number, a decimal number or a timestamp - string with format "YYYY-mm-DD HH:MM:SS" - --lasOutput - Specify the output point cloud must be generated using LAS format - --zipOutput - Specify the output point cloud and fullwave must be zipped - --lasScale - Specify the scale factor used to generate LAS output - -j OR --njobs OR --nthreads - Specify the number of simultaneous threads to be used to compute - the simulation - If it is not specified or it is specified as 0, then all available - threads will be used to compute the simulation - --rebuildScene - Force scene rebuild even when a previosly built scene is available - --disablePlatformNoise - Disable platform noise, no matter what is specified on XML files - --disableLegNoise - Disable leg noise, no matter what is specified on XML files - - Available logging verbosity OPTIONAL ARGUMENTS are: - --silent - Nothing will be reported - -q OR --quiet - Only errors will be reported - -v - Errors, information and warnings will be reported - -vv OR -v2 - Everything will be reported - IF NONE IS SPECIFIED - Errors and information will be reported by default - - Available logging output mode OPTIONAL ARGUMENTS are: - --logFile - Reports will be emitted through standard output and output file - --logFileOnly - Reports will be emitted through output file only - IF NONE IS SPECIFIED - Reports will be emitted through standard output only - - Unzip compressed output: - --unzip - When helios++ is executed with --zipOutput flag, output files are - compressed. They can be decompressed using --unzip. - The path to a readable helios++ compressed output file must be - given through input path. - The path to a writable file/location must be given through - output path. -``` - -The demo simulation can be executed as follows: - -**LINUX** -``` -./helios data/surveys/demo/tls_arbaro_demo.xml -``` - -**WINDOWS** -``` -helios.exe data/surveys/demo/tls_arbaro_demo.xml -``` - ## License See [LICENSE.md](LICENSE.md) From 78e13581efada79630bc0272f29b7b6cba88289a Mon Sep 17 00:00:00 2001 From: han16nah <41050948+han16nah@users.noreply.github.com> Date: Wed, 18 Oct 2023 17:11:37 +0200 Subject: [PATCH 3/3] Update BUILDME.md --- BUILDME.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/BUILDME.md b/BUILDME.md index 76d85ae6c..07d9fc132 100644 --- a/BUILDME.md +++ b/BUILDME.md @@ -478,7 +478,7 @@ at the end: ## Wiki You can build the HELIOS++ Wiki locally as html files using `mkdocs`. For this, the wiki is included as a `git submodule`. -Make sure you have the latest copy of the submodule checked out with `git submodule update --init --recursive` +Make sure you have the latest copy of the submodule checked out with `git submodule update --init --recursive` or, if not checking out for the first time, `git submodule update --recursive --remote` (to update to latest tip of the submodule). Then change to the respective directory: `cd wiki-repo`