Skip to content

Commit

Permalink
Merge pull request #37 from afraniomelo/main
Browse files Browse the repository at this point in the history
adjustment in readme
  • Loading branch information
afraniomelo authored Sep 3, 2024
2 parents be79af3 + 54fdc14 commit 973e86d
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 4 deletions.
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,14 @@ For further information, please refer to the [documentation](https://bibmon.read
Installation
----------------------

`BibMon` can be installed using `pip`:
`BibMon` can be installed using [pip](https://pypi.org/project/bibmon/):

pip install bibmon

Or [conda](https://anaconda.org/conda-forge/bibmon):

conda install conda-forge::bibmon

Available Models
----------------------

Expand All @@ -39,7 +43,8 @@ Essentially, the library is used in two steps:

Specifically, the implemented control charts are based on squared prediction error (SPE).

The examples in the `notebooks/` directory demonstrate the main functionalities of `BibMon`. The API reference can be generated using the Sphynx package from the files in the `docs/` directory.
For more details, please refer to the [tutorials](https://bibmon.readthedocs.io/en/latest/tutorials.html) available in the documentation to learn about the main functionalities of `BibMon`. You can find the corresponding Jupyter Notebooks for these tutorials in the `docs/source/` directory.


Features
----------------------
Expand Down
9 changes: 8 additions & 1 deletion docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,17 @@ This section covers the installation of BibMon.
Installing from PyPI
--------------------------------

To install Requests, you can use pip::
To install BibMon, you can use pip::

$ pip install bibmon

Installing from conda-forge
--------------------------------

Alternatively, you can use conda::

$ conda install conda-forge::bibmon

Get the Source Code
-------------------

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
name='bibmon',
description='Library with routines for data-driven process monitoring.',
license='Apache 2.0',
version='1.1.3',
version='1.1.4',
long_description=README,
long_description_content_type='text/markdown',
url='https://github.com/petrobras/bibmon',
Expand Down

0 comments on commit 973e86d

Please # to comment.