/Ornamental-value-estimation

This project is related to a No-SQL database, whose data are referred to autoctone botanic species. The final goal is creating a function that performs the estimation of the ornamental value, given the specific characteristics of a single species.

Primary LanguageJupyter NotebookOtherNOASSERTION

Ornamental Value Estimation

Jupyter Notebook Python Microsoft Excel MongoDB

Licence

💐 Brief Description

This project is related to a No-SQL database, whose data are referred to autoctone botanic species.

The final goal is creating a function that performs the estimation of the ornamental value, given the specific characteristics of a single species.

(The ornamental value is a figure of merit that can be used in order to decide if a specific species can be planted in a specific area. The higher the ornamental value, the best the result)

You can find an in-depth study of this topic at this link.

🖥 Download

Link to the whole .json database file.

🎥 Presentation

Link to the project .pdf presentation.

ℹ️ Other

Setting up the local environment

1) Clone this Repository

...and navigate to its root directory.

2) Create a Python Virtual Environment

...calling it .my_env

(For gitignore-related reasons).

$ python3 -m venv .my_env

(You'll be prompted to install the venv module if you don't have it yet).

3) Activate the Virtual Environment

$ source .my_env/bin/activate

If this command doesn't work try with:

$ . .my_env/bin/activate

In Windows 10 try with :

.\.my_env\Scripts\activate.bat

(You should notice that the console starts displaying the virtual environment's name before your username and the dollar-sign).

4) Install this App's Dependencies

In the virtual environment you just created run:

(.my_env)$ pip install -r requirements.min.txt

If instead you want to install the very same versions of the libraries that we used run:

(.my_env)$ pip install -r requirements.txt
Run the app on localhost

1) Install jupyter notebook

If you have not already installed on your device, run:

$ pip install notebook

2) Run jupyter notebook

(.my_env)$ jupyter notebook

3) Open main.ipynb and Enjoy 🤠

Setup the database credentials

The file settings/db_config.csv should contain the configuration settings needed to connect to the MongoDB instance.

The file format should be as follows:

key,val
username,<your-username-here>
password,<your-password-here>
database,<your-database-name-here>
cluster,<your-cluster-address-here>
Enable the dark theme on jupyter notebook

To switch to the dark jupyter notebook theme run:

(.my_env)$ pip install jupyterthemes
(.my_env)$ jt -t chesterish

image