Installation

Pre-requisites

moonstone currently works with version of Python 3.6 and 3.7.

Note

We highly recommend the use of a virtual environment such as virtualenv, pyenv or conda.

Installation procedure

Pip

You can use pip to install moonstone of the latest stable version published on pypi:

pip install moonstone

Manually

Note

This is particularly useful when you wish to install a version under development from any branches of the Github repository.

Clone the repository and install moonstone with the following commands:

git clone https://github.com/motleystate/moonstone.git
cd moonstone
pip install .     # you can use -e option to make an editable install

Note

Installing moonstone will install the following dependencies :

• pandas (==1.0.1)

• scikit-learn (==0.21.3)

• matplotlib

• plotly

• statsmodels

• python-slugify

• pyaml

• numpy (==1.18.1)

Uninstallation procedure

You can remove moonstone with the following command:

pip uninstall moonstone

Note

This will not uninstall dependencies. To do so you can make use of the pip-autoremove tool pip-autoremove or set up your environment with pipenv or poetry…