https://github.com/amatofrancesco99/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.
https://github.com/amatofrancesco99/ornamental-value-estimation
autoctone-botanic-species botanics excel-to-json mongo-db no-sql ornamental-value
Last synced: 2 months ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/amatofrancesco99/ornamental-value-estimation
- Owner: Amatofrancesco99
- License: other
- Created: 2022-01-12T19:35:47.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-04-19T17:23:41.000Z (about 3 years ago)
- Last Synced: 2024-12-21T00:16:22.449Z (6 months ago)
- Topics: autoctone-botanic-species, botanics, excel-to-json, mongo-db, no-sql, ornamental-value
- Language: Jupyter Notebook
- Homepage:
- Size: 4.6 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Ornamental Value Estimation
[](./LICENSE)
## đ 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](http://csu.unipv.it/wp-content/uploads/2022/01/Tesi-Colombini.pdf).
## đĨ Download
[Link to the whole **`.json` database** file](https://drive.google.com/uc?export=download&id=1qbFqC_eSVcBgorBP0HvW2fprnrDihGQP).
## đĨ Presentation
[Link to the project **`.pdf` presentation**](https://github.com/Amatofrancesco99/Ornamental-value-estimation/blob/main/presentation/presentation.pdf).
## âšī¸ 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,
password,
database,
cluster,
```
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
```
