All command line tools have a help included. You can access it by the "--help" parameter
All command line tools have a help included. You can access it by the "--help" parameter
...
```
python3 ./experiment_control.py -v run
python3 ./experiment_control.py -v run
...
```
* -v is verbosity. To spam stdout use -vvv
* -v is verbosity. To spam stdout use -vvv
* run is the default command
* run is the default command
@ -56,20 +69,42 @@ python3 ./experiment_control.py -v run
Most of the configuration is done in the yaml config file. For more details check out the full documentation
Most of the configuration is done in the yaml config file. For more details check out the full documentation
## The real documentation
## Testing
This README is just a short overview. In depth documentation can be found in the *doc* folder.
Basic code and unit tests can be run by
```
make test
```
That way you can also see if your env is set up properly.
Documentation is using sphinx
It will also check the plugins you write for compatibility.
https://www.sphinx-doc.org/en/master/index.html
the tool
Generate it switching to the directory doc and calling
```
./pydantic_test.py
```
*make all*
is *not* included in the make test. But you can use it manually to verify your yaml config files. As they tend to become quite complex this is a time safer.
## More documentation
This README is just a short overview. In depth documentation can be found in the *doc* folder.
Documentation is using sphinx. To compile it, go into this folder and call
```
make html
```
Use your browser to open build/html/index.html and start reading.
## Development
## Development
The code is stored in [https://github.com/avast/PurpleDome](https://github.com/avast/PurpleDome). Feel free to fork it and create a pull request.
Development happens in *feature branches* branched of from *develop* branch. And all PRs go back there.
Development happens in *feature branches* branched of from *develop* branch. And all PRs go back there.
The branch *release* is a temporary branch from *develop* and will be used for bug fixing before a PR to *main* creates a new release. Commits in main will be marked with tags and the *changelog.txt* file in human readable form describe the new features.
The branch *release* is a temporary branch from *develop* and will be used for bug fixing before a PR to *main* creates a new release. Commits in main will be marked with tags and the *changelog.txt* file in human readable form describe the new features.