igdb/README.org

70 lines
1.2 KiB
Org Mode
Raw Normal View History

2019-11-17 17:10:59 +01:00
* IGDB: Internation Glacier Database
2020-01-10 11:59:54 +01:00
The IGDB is a database, that uses data from the [[https://dx.doi.org/10.5904/wgms-fog-2019-12][WGMS]] to illustrate the consequences of climate change.
Our system allows you to visualize data with tables and plots, via our intuitive
Web UI.
2020-01-10 12:08:56 +01:00
#+CAPTION: Table
2020-01-10 12:20:32 +01:00
#+ATTR_HTML: :width 120
2020-01-10 12:08:56 +01:00
[[./assets/screenshots/Table.png]]
2020-01-10 11:59:54 +01:00
** Technologies used
- Flask
- SQLAlchemy
- Pandas
** Requirements
- Python3
- Pip
- Pipenv
- MySQL/MariaDB
** Installation
1. Clone the repository:
2020-01-10 12:20:32 +01:00
#+BEGIN_SRC sh
2020-01-10 11:59:54 +01:00
git clone https://coolneng.duckdns.org/gitea/coolneng/igdb
2020-01-10 12:20:32 +01:00
#+END_SRC
2020-01-10 11:59:54 +01:00
2. Change the working directory to the project:
2020-01-10 12:20:32 +01:00
#+BEGIN_SRC sh
2020-01-10 11:59:54 +01:00
cd igdb
2020-01-10 12:20:32 +01:00
#+END_SRC
2020-01-10 11:59:54 +01:00
3. Install the dependencies:
2020-01-10 12:20:32 +01:00
#+BEGIN_SRC sh
2020-01-10 11:59:54 +01:00
pipenv install
2020-01-10 12:20:32 +01:00
#+END_SRC
2020-01-10 11:59:54 +01:00
All the dependencies will be installed inside a virtualenv.
** Usage
1. Start a shell inside the virtualenv:
2020-01-10 12:20:32 +01:00
#+BEGIN_SRC sh
2020-01-10 12:08:56 +01:00
pipenv sh
2020-01-10 12:20:32 +01:00
#+END_SRC
2020-01-10 11:59:54 +01:00
2. Start the Flask server:
2020-01-10 12:20:32 +01:00
#+BEGIN_SRC sh
2020-01-10 11:59:54 +01:00
flask run
2020-01-10 12:20:32 +01:00
#+END_SRC
2020-01-10 11:59:54 +01:00
3. When prompted for a password, insert your MySQL/MariaDB root password
The database will be created and populated automatically, if needed, each time the server is executed
3. The website can be accessed via the URL:
2020-01-10 12:20:32 +01:00
- localhost:5000