* Add conda support: if you are not using conda, please remove [environment.yml](environment.yml) from your CLI.
* Add localization outputs feature
* Add proposal outputs feature
* Replace merge-chunks `result-location` parameter by `system-cache-dir`
* Add *LICENSE.txt* check during validate-system: your CLI should have a *LICENSE.txt* file at its root.
* Improve CLI and ActEV_Scorer installation
* Update entry-point parsers
* Update doc
* Remove CI for now
Also earlier...
* Add train_system entry point
* Multiple minor changes
1.2.3 - 02.27.20
----------------
================
* Upgrade to python3.
* Add [pep8](https://www.python.org/dev/peps/pep-0008/) compliance for NIST code.
* Add `--debug` option to entry point `system-setup`.
...
...
@@ -31,89 +9,87 @@ Also earlier...
* Add script `merge_dev_into_master.sh`. It pulls the lastest changes, merges `development` on `master`, creates a tag and pushes.
1.2.2 - 08.14.19
----------------
================
* Add a script example to demonstrate data download, execution of the CLI, and validation of the outputs.
* Add support for environement variables available from one step to another. (diva_evaluation_cli.bin.private_src.implementation.utils.actev_cli_environment.*)
1.2.1 - 07.24.19
----------------
================
* Add baseline outputs on ActEV-Eval-CLI-Validation-Set3
* Update baseline outputs on ActEV-Eval-CLI-Validation-Set1 and ActEV-Eval-CLI-Validation-Set2
* Bug fixes in the validation-execution command
1.2.0 - 07.01.19
----------------
* Update validate-execution command with a `--score` flag <https://gitlab.kitware.com/actev/diva_evaluation_cli/issues/11>
* Update validate-system command, and add a `--strict` flag <https://gitlab.kitware.com/actev/diva_evaluation_cli/issues/12>
1.2.0 - 07.01.19
================
* Update validate-execution command with a `--score` flag https://gitlab.kitware.com/actev/diva_evaluation_cli/issues/11
* Update validate-system command, and add a `--strict` flag https://gitlab.kitware.com/actev/diva_evaluation_cli/issues/12
* Improved documentation for each command
* New _free disk_ metric in resources monitoring
* Bug fixes
1.1.9 - 05.23.19
----------------
================
* Bug fixes
1.1.8 - 05.15.19
----------------
================
* Bug fixes
* Less constraints on the container_output validation
1.1.7 - 04.09.19
----------------
================
* Bug fixes
* Add a new validation set: ActEV-Eval-CLI-Validation-Set2
1.1.6 - 04.01.19
----------------
================
* Improve get-system 'git': add 'recursive' option to download submodules
1.1.5 - 03.04.19
----------------
================
* Remove get-system subcommand: docker
* Rename get-system 'other' subcommand into 'archive'
* Improve get-system 'archive' and 'git' subcommands
See `diva_evaluation_cli/bin/install.sh -h` for more options. If using `--all`, make sure to install the submodules before.
N.B.: We recommend to set the `-c` and `-s` options to what will be used as `system_cache_dir` by the entry_points ; otherwise, some operations like `validate-execution` will likely fail.
### Test the installation
Test the installation
---------------------
Run the following command:
```bash
actev
```
$ actev
```
You should be able to see the available subcommands.
## Usage
### Command line
Usage
=====
Command line
------------
Run the following command to obtain help with the CLI:
```bash
actev -h
```
$ actev -h
```
### Documentation
Documentation
-------------
Consult the documentation to have information: [CLI](doc/cli_commands/index.md)
## Fork it and develop your own implementation
### Fork it
Fork it and develop your own implementation
===========================================
Fork it
-------
Click on the “Fork” button to make a copy of the repository in your own space and add this repository as a remote upstream to get the latest updates
The CLI components are included in the `bin` directory, you do not have to modify it. To add your code, simply implement the methods in `src/entry_points`.
We suggest you to call your scripts in the entry point methods and store them in `src`.
More information about the development and the update of the CLI here: [development](doc/development.md).
Develop it
----------
:warning: Changes in release 1.2.4:
The CLI components are included in the `bin` directory, you do not have to modify it.
To add your code, you simply have to implement the methods in `src/entry_points`.
* Content of `/bin` from **your** CLI will be ignored. For example, if you used to edit `/bin/install.sh`, your submissions will likely fail from now. The best way is to move this kind of files/scripts into entry-points `actev-system-setup` and/or `actev-experiment-init`.
* CLI installation now supports [conda](https://docs.conda.io/en/latest/) environments. This is now the default way for installing the CLI dependencies, **however if you wish to stick with `pip`, you will have to remove `environment.yml` from your CLI.**
* Entry-point `validate-system` now requires the existence of a `LICENSE.txt` file at the root of your project.
We suggest you to call your scripts in the entry point methods and store them in `src`.
More information about the development and the update of the CLI here: [development](doc/development.md)
