Update Readme and Citation
This commit is contained in:
parent
1e52bcae0d
commit
aeb5c8b839
GPG Key ID:
9893DA236405AF57
|
|
@ -64,9 +64,10 @@ CLOSED: [2020-01-08 Wed 03:18]
|
|||
CLOSED: [2020-01-09 Thu 20:57]
|
||||
- [X] Text search for glaciers
|
||||
- [X] Form seach for a year
|
||||
*** TODO Documentation [0/2] [0%]
|
||||
*** TODO Documentation [1/3] [33%]
|
||||
- [ ] Code
|
||||
- [ ] Explanations (uid as Varchar, ORM)
|
||||
- [ ] Explanations (uid as Varchar, technologies used)
|
||||
- [X] Readme
|
||||
*** TODO Deployment [0/1] [0%]
|
||||
- [ ] Virtualenv installation script
|
||||
*** DONE Frontend [2/2] [100%]
|
||||
|
|
|
|||
63
README.org
63
README.org
|
|
@ -1,3 +1,64 @@
|
|||
* IGDB: Internation Glacier Database
|
||||
|
||||
The IGDB is a database, that uses data from the [[http://dx.doi.org/10.5904/wgms-fog-2018-11][WGMS]] to illustrate the consequences of climate change.
|
||||
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.
|
||||
|
||||
** Technologies used
|
||||
|
||||
- Flask
|
||||
- SQLAlchemy
|
||||
- Pandas
|
||||
|
||||
** Requirements
|
||||
|
||||
- Python3
|
||||
- Pip
|
||||
- Pipenv
|
||||
- MySQL/MariaDB
|
||||
|
||||
** Installation
|
||||
|
||||
1. Clone the repository:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
git clone https://coolneng.duckdns.org/gitea/coolneng/igdb
|
||||
#+END_SRC
|
||||
|
||||
2. Change the working directory to the project:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
cd igdb
|
||||
#+END_SRC
|
||||
|
||||
3. Install the dependencies:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
pipenv install
|
||||
#+END_SRC
|
||||
|
||||
All the dependencies will be installed inside a virtualenv.
|
||||
|
||||
** Usage
|
||||
|
||||
|
||||
1. Start a shell inside the virtualenv:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
pipenv shell
|
||||
#+END_SRC
|
||||
|
||||
2. Start the Flask server:
|
||||
|
||||
#+BEGIN_SRC shell
|
||||
flask run
|
||||
#+END_SRC
|
||||
|
||||
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:
|
||||
|
||||
localhost:5000
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
@misc{wgms-db,
|
||||
author = {World Glacier Monitoring Service (WGMS)},
|
||||
title = {{Fluctuations of Glaciers Database}},
|
||||
publisher = {World Glacier Monitoring Service (WGMS)},
|
||||
year = 2018,
|
||||
month = nov # "~3,",
|
||||
doi = {10.5904/wgms-fog-2018-11},
|
||||
}
|
||||
author = {World Glacier Monitoring Service (WGMS)},
|
||||
title = {{Fluctuations of Glaciers Database}},
|
||||
publisher = {World Glacier Monitoring Service (WGMS)},
|
||||
year = 2019,
|
||||
month = dec # "~2,",
|
||||
doi = {10.5904/wgms-fog-2019-12}
|
||||
}
|
||||
|
|
|
|||
162
docs/UML.org
162
docs/UML.org
|
|
@ -1,162 +0,0 @@
|
|||
* Diagramas UML
|
||||
|
||||
** Functional
|
||||
|
||||
#+begin_src plantuml :file ../Assets/Diagrams/FD.png
|
||||
:Script|
|
||||
split
|
||||
:Alta de un glaciar;
|
||||
split again
|
||||
:Inclusión de datos anuales;
|
||||
split again
|
||||
:Cálculo de las variaciones anuales;
|
||||
split again
|
||||
:Actualización de la base de datos;
|
||||
split again
|
||||
:Alta del administrador;
|
||||
:Administrador|
|
||||
:Resolución de conflictos;
|
||||
endsplit
|
||||
:IGDB|
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
[[file:../Assets/Diagrams/FD.png]]
|
||||
|
||||
|
||||
** Data-flow
|
||||
|
||||
#+begin_src plantuml :file ../Assets/Diagrams/DF1.png
|
||||
:Script|
|
||||
:Alta del Glaciar;
|
||||
-> Nuevo glaciar;
|
||||
:Glaciar<
|
||||
:IGDB|
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
[[file:../Assets/Diagrams/DF1.png]]
|
||||
|
||||
#+begin_src plantuml :file ../Assets/Diagrams/DF2.png
|
||||
:Script|
|
||||
:Inclusión de datos anuales;
|
||||
-> Añadir información;
|
||||
:Glaciar<
|
||||
:IGDB|
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
[[file:../Assets/Diagrams/DF2.png]]
|
||||
|
||||
#+begin_src plantuml :file ../Assets/Diagrams/DF3.png
|
||||
:Script|
|
||||
:Cálculo de las variaciones anuales;
|
||||
:Inclusión de datos anuales;
|
||||
-> Añadir información;
|
||||
:Glaciar<
|
||||
:IGDB|
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
[[file:../Assets/Diagrams/DF3.png]]
|
||||
|
||||
#+begin_src plantuml :file ../Assets/Diagrams/DF4.png
|
||||
:Script|
|
||||
:Alta del administrador;
|
||||
-> Nuevo administrador;
|
||||
:Administrador<
|
||||
:IGDB|
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
[[file:../Assets/Diagrams/DF4.png]]
|
||||
|
||||
#+begin_src plantuml :file ../Assets/Diagrams/DF5.png
|
||||
:Script|
|
||||
:Actualización de la base de datos;
|
||||
:Inclusión de datos anuales;
|
||||
-> Añadir información;
|
||||
:Glaciar<
|
||||
:IGDB|
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
[[file:../Assets/Diagrams/DF5.png]]
|
||||
|
||||
#+begin_src plantuml :file ../Assets/Diagrams/DF6.png
|
||||
:Script|
|
||||
:Administrador<
|
||||
:Resolución de conflictos;
|
||||
-> Selecciona los datos correctos;
|
||||
:Actualización de la base de datos;
|
||||
:IGDB|
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
[[file:../Assets/Diagrams/DF6.png]]
|
||||
|
||||
** Black box
|
||||
|
||||
#+begin_src plantuml :file ../Assets/Diagrams/BB.png
|
||||
@startuml
|
||||
start
|
||||
:WGMS|
|
||||
:**Sistema**;
|
||||
:IGDB|
|
||||
end
|
||||
@enduml
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
[[file:../Assets/Diagrams/BB.png]]
|
||||
|
||||
** Entity Relationship
|
||||
|
||||
|
||||
#+begin_src plantuml :file ../Assets/Diagrams/ER.png
|
||||
@startuml
|
||||
hide circle
|
||||
skinparam linetype ortho
|
||||
entity "Glacier" as e01 {
|
||||
,* **glacier_id** : number <<generated>>
|
||||
--
|
||||
,*glacier_name : text
|
||||
--
|
||||
,*glacier_country: text
|
||||
}
|
||||
entity "Glacier yearly data" as e02 {
|
||||
,* **glacier_id** : number <<FK>>
|
||||
--
|
||||
,*glacier_volume: number
|
||||
--
|
||||
,*glacier_area: number
|
||||
--
|
||||
,*glacier_thickness: number
|
||||
--
|
||||
,*glacier_year: number
|
||||
}
|
||||
entity "Glacier yearly fluctuation" as e03 {
|
||||
,* **glacier_id** : number <<FK>>
|
||||
--
|
||||
,*glacier_area_change: number
|
||||
--
|
||||
,*glacier_volume_change: number
|
||||
--
|
||||
,*glacier_thickness_change: number
|
||||
--
|
||||
,*glacier_year: number <<FK>>
|
||||
}
|
||||
entity "Admin" as e04 {
|
||||
,*admin_id : number <<generated>>
|
||||
--
|
||||
,*admin_creation_date: date
|
||||
}
|
||||
e01 ||..|{ e02
|
||||
e02 ||..|| e03
|
||||
e01 ||..|{ e03
|
||||
e04 ||..o| e01
|
||||
@enduml
|
||||
#+end_src
|
||||
|
||||
#+RESULTS:
|
||||
[[file:../Assets/Diagrams/ER.png]]
|
||||
Loading…
Reference in New Issue