| ... | ... | @@ -24,7 +24,12 @@ This provides full information (apart from any external data added by user) requ |
|
|
|
# Good practices
|
|
|
|
1. For each project use a separate folder, do not mix results from various project in the same files. Use a meaningful name for folders.
|
|
|
|
2. Use meaningful `outprefix` names.
|
|
|
|
3. Do not modify output files, except `wtxt` file. This one is designed to store various metadata information, including your comments. `wtxt` file is easy to reproduce in case if you destroy it accidentally, which is not the case of other files. Add your comments/remarks/ect in form of comments starting with `#`.
|
|
|
|
3. Do not modify output files, except `wtxt` file. This one is designed to store various metadata information, including your comments. `wtxt` file is easy to reproduce in case if you destroy it accidentally, which is not the case of other files. Add your comments/remarks/etc in form of comments starting with `#`.
|
|
|
|
4. When copying results to a new location/machine, copy all files assisted with the run. The simplest way is to execute the command (for more info see [here](https://gitlab.fizyka.pw.edu.pl/gabrielw/wslda/-/wikis/Output%20files#copying-results-to-a-new-location)):
|
|
|
|
```bash
|
|
|
|
scp outprefix* new_location
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
|
|
To learn more about good practices related to results reproducibility issue see:
|
|
|
|
* [Creating Reproducible Data Science Projects](https://towardsdatascience.com/creating-reproducible-data-science-projects-1fa446369386) |
|
|
\ No newline at end of file |
