Merge pull request #32 from afraniomelo/main

adding requirements to source distribution
petrobras · Aug 31, 2024 · 8fb59ca · 8fb59ca
2 parents 4c39a0e + 6612257
commit 8fb59ca
Show file tree

Hide file tree

Showing 7 changed files with 17 additions and 10 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -11,7 +11,7 @@ In this guide we present how the expected contributions might be proposed.
 
 ## Getting started
 
-The recommended first step is to read the project's [README](README.md) for an overview of what this repository contains.
+The recommended first step is to read the project's [README](https://github.com/petrobras/BibMon/blob/main/README.md) for an overview of what this repository contains.
 
 ## Asking questions
 
@@ -21,8 +21,8 @@ Please do not open issues to ask questions. Please use the Discussions section a
 
 Before you can contribute to this project, we require you read and agree to the following documents:
 
-* [CODE OF CONDUCT](CODE_OF_CONDUCT.md);
-* [CONTRIBUTOR LICENSE AGREEMENT](CONTRIBUTOR_LICENSE_AGREEMENT.md);
+* [CODE OF CONDUCT](https://github.com/petrobras/BibMon/blob/main/CODE_OF_CONDUCT.md);
+* [CONTRIBUTOR LICENSE AGREEMENT](https://github.com/petrobras/BibMon/blob/main/CONTRIBUTOR_LICENSE_AGREEMENT.md);
 * This contributing guide.
 
 It is also very important to know, participate and follow the discussions. Click on the Discussions link that appears in the top menu.

diff --git a/MANIFEST.in b/MANIFEST.in
@@ -0,0 +1 @@
+include requirements.txt
diff --git a/docs/source/install.rst b/docs/source/install.rst
@@ -8,13 +8,12 @@ Installing from PyPI
 
 To install Requests, you can use pip::
 
-    $ pip install bimon
+    $ pip install bibmon
 
 Get the Source Code
 -------------------
 
-BibMon is developed on GitHub, where the code is
-`available at <https://github.com/petrobras/bibmon>`_.
+BibMon is developed on GitHub, where the code is available `here <https://github.com/petrobras/bibmon>`_.
 
 You can either clone the public repository::
 

diff --git a/docs/source/requirements.txt b/docs/source/requirements.txt
@@ -3,4 +3,12 @@ sphinx-rtd-theme
 sphinx-autodocgen
 sphinxcontrib-napoleon
 myst-nb
-bibmon
+bibmon
+numpy
+scipy
+scikit-learn
+pandas
+matplotlib
+seaborn
+statsmodels
+optuna
diff --git a/docs/source/tutorial_real_process.ipynb b/docs/source/tutorial_real_process.ipynb
@@ -1254,7 +1254,7 @@
     "\n",
     "In this notebook, an example of offline monitoring study was presented using the `complete_analysis` and `comparative_table` functions.\n",
     "\n",
-    "For a more flexible example of using `BibMon` functionalities, please refer to the `tep_monitoring.ipynb` notebook, where lower-level functions are used to perform the analyses."
+    "For a more flexible example of using `BibMon` functionalities, please refer to the `tutorial_tep.ipynb` notebook, where lower-level functions are used to perform the analyses."
    ]
   }
  ],

diff --git a/docs/source/tutorial_tep.ipynb b/docs/source/tutorial_tep.ipynb
@@ -21,7 +21,6 @@
     "warnings.filterwarnings(\"ignore\", category=DeprecationWarning)\n",
     "    \n",
     "import bibmon\n",
-    "import pandoc\n",
     "import pandas as pd\n",
     "import matplotlib.pyplot as plt"
    ]

diff --git a/setup.py b/setup.py
@@ -29,7 +29,7 @@
     name='bibmon',
     description='Library with routines for data-driven process monitoring.',
     license='Apache 2.0',
-    version='1.1.0',
+    version='1.1.1',
     long_description=README,
     long_description_content_type='text/markdown',
     url='https://github.com/petrobras/bibmon',