Update Publishing Reproducible Papers at Idiap authored by Vedrana KRIVOKUCA's avatar Vedrana KRIVOKUCA
......@@ -134,8 +134,6 @@ $ conda env export > environment.yml
Now, open at your `environment.yml` file. If it contains `zc.buildout`, remove the corresponding version number so that, if the version is upgraded at a later point, the user can still do `buildout` in their re-created environment. You can also feel free to remove any packages in `environment.yml` that you know **for sure** are not needed by your paper package (if you are not sure, it's best not to remove anything). Finally, remove the "prefix" section of your `environment.yml` file, since the user of your package does not need to know the path to your working directory (anyway, their path will be different).
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).
To make sure your frozen environment works as expected, test it on a different computer as follows, replacing `bob.paper.isba2018_entropy` with your package name and `bob.paper.isba2018_entropy.env` with the name of your previously-created environment:
```sh
......@@ -151,6 +149,8 @@ When you run your experiments in the created environment, your results should be
Alternatively, you could simply test that your environment has been correctly created by incorporating the creation commands into your `.gitlab-ci.yml` file (see the "Continuous Integration" section, above).
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
You should make your software package public. This normally has to go through a Software Disclosure agreement between you and Idiap. In order to kick-start the process open a help-desk ticket and go on from there. Include your supervisor in CC on that ticket, alongside with all involved partners. This process **can take up to a couple of weeks** to go through, as it may involve a software review.
......
......