Merge pull request #106 from petrobras/documentation_improvements

Documentation improvements
petrobras · Jun 21, 2024 · 41129e8 · 41129e8
2 parents b420a1b + 71c73c9
commit 41129e8
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/LIST_OF_CITATIONS.md b/LIST_OF_CITATIONS.md
@@ -170,3 +170,5 @@ Journal of Computational and Applied Mathematics. 2020. https://doi.org/10.1016/
 1. A.P.F. Machado. Methodologies to Improve One-Class Classifier Performance Applied to Multivariate Time Series. Universidade Federal do Espírito Santo. Doctoral thesis. 2024. https://github.com/petrobras/3W/raw/main/docs/doctoral_thesis_andre_machado.pdf.
 
 1. E.M. Turan. Advances in Optimisation and Machine Learning for Process Systems Engineering. Norwegian University of Science and Technology. Doctoral thesis. 2024. https://github.com/petrobras/3W/raw/main/docs/doctoral_thesis_evren_turan.pdf.
+
+1. T.L.B. Dias, M.A. Marins, C.L. Pagliari, R.M.E. Barbosa, M.L.R. de Campos, E.A.B. Silva, S.L.Netto. Development of Oilwell Fault Classifiers Using a Wavelet-Based Multivariable Approach in a Modular Architecture. Society of Petroleum Engineers Journal. 2024. https://doi.org/10.2118/221463-PA.
diff --git a/README.md b/README.md
@@ -159,7 +159,7 @@ For a contribution of yours to be listed here, follow the instructions detailed
 
 ## Reproducibility
 
-For all results generated by the 3W toolkit to be consistent, we recommend you create and use a virtual environment with the packages versions specified in the [environment.yml](environment.yml), which was generated with [conda](https://docs.conda.io). First you have to install the [Anaconda](https://anaconda.org/). Then open an Anaconda Prompt, make sure the current directory is the directory where you have the 3W and run the following commands as needed:
+For all results generated by the 3W toolkit to be consistent, we recommend you create and use a virtual environment with the packages versions specified in the [environment.yml](environment.yml), which was generated with [conda](https://docs.conda.io). Our current recommendation is to use the conda distributed by [Miniforge](https://conda-forge.org/download/). Download and install Miniforge according to the official instructions. Open a prompt on your operating system (Windows, Linux or MacOS). Make sure the current directory is the directory where you have the 3W. Run the following commands as needed:
 
 * To create a virtual environment from our [environment.yml](environment.yml): 
 ```
Original file line number	Diff line number	Diff line change
Expand Up		@@ -170,3 +170,5 @@ Journal of Computational and Applied Mathematics. 2020. https://doi.org/10.1016/
		1. A.P.F. Machado. Methodologies to Improve One-Class Classifier Performance Applied to Multivariate Time Series. Universidade Federal do Espírito Santo. Doctoral thesis. 2024. https://github.com/petrobras/3W/raw/main/docs/doctoral_thesis_andre_machado.pdf.

		1. E.M. Turan. Advances in Optimisation and Machine Learning for Process Systems Engineering. Norwegian University of Science and Technology. Doctoral thesis. 2024. https://github.com/petrobras/3W/raw/main/docs/doctoral_thesis_evren_turan.pdf.

		1. T.L.B. Dias, M.A. Marins, C.L. Pagliari, R.M.E. Barbosa, M.L.R. de Campos, E.A.B. Silva, S.L.Netto. Development of Oilwell Fault Classifiers Using a Wavelet-Based Multivariable Approach in a Modular Architecture. Society of Petroleum Engineers Journal. 2024. https://doi.org/10.2118/221463-PA.