... | ... | @@ -64,7 +64,7 @@ A quick overview of these files: |
|
|
* `buildout.cfg` contains the basic recipe to create a working environment using your paper package
|
|
|
* `environment.yml` contains the precise list of conda packages required to re-build, from scratch, the work environment in which you know the paper will successfuly run **and** produce the same results you published
|
|
|
* `requirements.txt` contains the **direct** dependencies of your package (everything you `import` in **your** code). You don't need to include here *indirect* dependencies
|
|
|
* `setup.py` corresponds to the Python packaging instructions. It reads `requirements.txt` and defines what this package name is and how to install it.
|
|
|
* `setup.py` corresponds to the Python packaging instructions. It reads `requirements.txt` and defines what this package name is and how to install it. Read more about it [here](https://www.idiap.ch/software/bob/docs/bob/bob.extension/stable/pure_python.html#setting-up-your-package)
|
|
|
|
|
|
More complex packaging *may* be required in special cases. For those, please refer to our complete [Bob extension guide](https://www.idiap.ch/software/bob/docs/bob/bob.extension/stable/index.html).
|
|
|
|
... | ... | @@ -112,14 +112,9 @@ test: |
|
|
The `tags` section of this YAML file is important as it tells the Gitlab CI infrastructure where to run your tests. Make sure you go to the "Settings / CI/CD" of your software package in Gitlab and enable the corresponding runners.
|
|
|
|
|
|
|
|
|
### Organizing the contents of the `bob` directory
|
|
|
|
|
|
[tbd]
|
|
|
|
|
|
|
|
|
### Creating the `environment.yml` file
|
|
|
|
|
|
[tbd]
|
|
|
[tbd]
|
|
|
|
|
|
|
|
|
### Software Disclosure Agreement
|
... | ... | |