Skip to content

Latest commit

 

History

History
51 lines (38 loc) · 2.75 KB

README.md

File metadata and controls

51 lines (38 loc) · 2.75 KB

Welcome to the repository of the Website that shows the paper's results

Website Super linter Codacy Badge

The website is coded in Python, using the framework Dash. The data is stored on AWS s3. We use Cloud Run from Google Cloud Platform to host our website.

Contribute to the project

The fact that you cannot have access to the data stored on AWS (since we don't share the credentials) makes it harder to contribute to the project. However, you can still propose the some changes with a pull request.

Once you have forked the repository and cloned it, you can install the package with its development dependencies using:

pip install -e .[env]

The command launch_local_website allows you to test the website locally.

If you are using Visual Studio Code, a .devcontainer folder is already prepared so that you can work in a dedicated container.

Feel free to discuss about you ideas in the discussion section.

Structure of the website

The website is constructed as follows :

📜Dockerfile (calls index.py)
📦dash_website
 ┣ 📂age_prediction_performances
 ┃ ┗ 📜age_prediction_performances.py
 ┣ 📂datasets
 ┃ ┣ 📜images.py
 ┃ ┣ 📜scalars.py
 ┃ ┣ 📜time_series.py
 ┃ ┗ 📜videos.py
 ┣ 📂... (the other folders)
 ┃ ┗ 📜 ... (the page of that folder)
 ┣ 📜app.py (define the app)
 ┗ 📜index.py (calls the different pages)

There are two different organisations of the pages :

  • the one showed in the website. This organisation is that same as the one from actual paper.
  • the one from the data storage. This organisation is inherited from the way we store the data on AWS. It is shaping the way the folders are organized in this repository.

Each page has the same structure : a layout python object, and some attributes of this layout can be modified using callbacks.

How to deploy

A CI / CD workflow has been created with Git Actions in order to deploy the website automatically on demand. You can find the development version of the website here.