プロジェクト

全般

プロフィール

« | 次 » 

リビジョン bb0129da

高徹 高橋 徹 さんが5年以上前に追加

  • ID bb0129da7f7207f9915ef3f52c20ef8b91f1e311
  • d3e9fb9a

Add descriptions for build, run, additional tool to README

差分を表示:

README.md
# Spectrum File Viewer
Visualize spectrum analized data as line chart with frequency axis and power axis.
The data is a binary format file exported by the Satellite Spectrum Monitoring System
Visualize spectrums as line charts with frequency axis and power axis.
The spectrum is read from a binary format file exported by the Satellite Spectrum Monitoring System
made by Glowlink Communications Technologies Inc.
## Build the program
This program is written in Java language, and build by JDK 11+ with JavaFX.
T.B.D.
1. Build by gradle
2. Build by IntelliJ IDEA
## Run the program
The build generates an executable module JAR file `SpectrumFileViewer.jar`.
T.B.D.
### Build requirements
* JDKs 11+ with OpenJFX are as follows:
* [ZuluFX](https://jp.azul.com/downloads/zulu-community/?architecture=x86-64-bit&package=jdk-fx)
* [Liberica JDK full](https://bell-sw.com/pages/downloads/?architecture=x86&package=jdk-full)
* Build tools are as follows:
* Gradle wrapper is included in this project.
* IntelliJ IDEA (Community Edition)
### by gradle
* Set PATH to JDK 11+ with OpenJFX javac
* Execute `gradlew build` in command line
### by IntelliJ IDEA
* Open from IntelliJ IDEA
* [Build] menu > [Build Project]
## Run the program in build environment
<img src="doc/images/build_launch-1.png" width="480">
### from a command line
```
D:\work\SpectrumFileViewer> java -p build\libs -m com.torutk.spectrum
```
### from an IntelliJ IDEA
* [Run] menu > [Edit Configurations], add new configuration of gradle with task run.
* run the configuration above.
## Operate the program
......
## Technical comments
T.B.D.
## Other tools
### Generate test spectrum data
This program has a command-line tool for generating test spectrum data file.
The generated spectrum data is based on a markov model.
#### usage
* under build environment, show usage
```
D:\work\SpectrumFileViewer> java -cp build\libs\SectrumFileViewer com.torutk.spectrum.data.RandomGenerator
Command line usage: -f <file> -p <probability> -u <upper shift> -l <lower shift>
file: spectrum data file to be generated
probability: of power increased (0.0 to 1.0) by markov model
upper shift: amount of power increase in a step
lower shift: amount of power decrease in a step
```
* for example, apply probability=0.65 upper shift=2 lower shift=4,
```
D:\work\SpectrumFileViewer> java -cp build\libs\SectrumFileViewer com.torutk.spectrum.data.RandomGenerator ^
-f gen_p0.65_u2_l4.dat -p 0.65 -u 2 -l 4
```
<img src="doc/images/random_generate-1.png" width="480">

他の形式にエクスポート: Unified diff