... | ... | @@ -112,7 +112,14 @@ The `tags` section of this YAML file is important as it tells the Gitlab CI infr |
|
|
|
|
|
### Creating the `environment.yml` file
|
|
|
|
|
|
[tbd]
|
|
|
In order to ensure that the user of your source code can **exactly** reproduce your published experimental results, you want to ensure that they are working in the **same environment.** This means that the user should be working with the same versions of all the Python/Bob packages and package dependencies that you used when running your experiments. An easy way to achieve this is to **freeze** your working environment into an `environment.yml` file, from which the user can then re-create the same working environment. To do this, execute the following commands in your terminal, replacing `bob.paper.isba2018_entropy` with the name of your project and `bob.paper.isba2018_entropy.env` with the name of your conda environment:
|
|
|
|
|
|
```sh
|
|
|
$ cd bob.paper.isba2018_entropy
|
|
|
$ source activate bob.paper.isba2018_entropy.env
|
|
|
$ conda env export > environment.yml
|
|
|
```
|
|
|
And that's it! All you need to do now is to include `environment.yml` in your `MANIFEST.in` file to make sure that your environment file is packaged along with your source code (when creating a PyPI package).
|
|
|
|
|
|
|
|
|
### Software Disclosure Agreement
|
... | ... | |