Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Wiki update #384

Merged
merged 3 commits into from
Oct 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
102 changes: 4 additions & 98 deletions BUILDME.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -479,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`

Expand All @@ -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 <survey_file_path> [OPTIONAL ARGUMENTS]
Perform requested simulation.

NOTICE specifying the path to the survey specification file is mandatory

Available general OPTIONAL ARGUMENTS are:
--assets <directory_path>
Specify the path to assets directory
--output <directory_path>
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 <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 <integer>
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 <input_path> <output_path>
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)
2 changes: 1 addition & 1 deletion wiki-repo/helios.wiki
2 changes: 1 addition & 1 deletion wiki-repo/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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'
Expand All @@ -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'
Expand Down