gmguarino/quotaclimat

QuotaClimat x Data For Good

• Pour rejoindre le projet https://dataforgood.fr/join puis sur le Slack #offseason_quotaclimat
• Pour en savoir plus sur le projet https://dataforgood.fr/projects/quotaclimat
• Pour la répartition des tâches https://dataforgood.slite.page/p/xECA5kt9LFqtOA/Comment-contribuer-au-projet-QuotaClimat-x-Data-For-Good

📒 Index

• Open source
• Development
  • File Structure
  • Setting up the environment

🔧 Development

📁 Repo structure

- notebooks ---------------------------- les analyses
        quickstart.ipynb --------------- un premier notebook Python d'analyse
        COP27/ ------------------------- COP27 notebook analysis
        nlp_hands_on.ipynb ----------- notebook using the data processing implemented in the repo, and quick eda
- quotaclimat -------------------------- package the dashboard
        data_processing ---------------- methods related to process raw and aggregated data
          read_format_deduplicate ------ read all files and put them together
        data_analytics ---------------- methods and figures answer the questions from media tree
          data_coverage.py ------------- coverage of extracts and keywords in samples
        utils --------------------------
            plotly_theme.py ------------ visual identity of the project's figures
- pages ------------------------ the different pages making the dashboard
app.py ------------------------- run dashboard

🔩 Setting up the environment

Doing the following step will enable your local environement to be aligned with the one of any other collaborator.

First install pyenv:

OS	Command
MacOS	cd - brew install pyenv # pyenv itself brew install pyenv-virtualenv # integration with Python virtualenvsec
Ubuntu	sudo apt-get update; sudo apt-get install make build-essential libssl-dev zlib1g-dev \ libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \ libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev libffi-dev liblzma-dev curl https://pyenv.run | bash

Make the shell pyenv aware:

OS	Command
MacOS	eval "$(pyenv init --path)" eval "$(pyenv init -)" eval "$(pyenv virtualenv-init -)"
Ubuntu	export PYENV_ROOT="$HOME/.pyenv" command -v pyenv >/dev/null || export PATH="$PYENV_ROOT/bin:$PATH" eval "$(pyenv init -)" eval "$(pyenv virtualenv-init -)"

Let's install a python version:

pyenv install 3.10.2 # this will take time

Check if it works properly, this command:

pyenv versions

should return:

  system
  3.10.2

Then you are ready to create a virtual environment. Go in the project folder, and run:

  pyenv virtualenv 3.10.2 quotaclimat
  pyenv local quotaclimat

You now need a tool to manage dependencies. Let's use poetry.

pip install poetry
poetry update

When you need to install a new dependency (use a new package, e.g. nltk), run

poetry add ntlk

After commiting to the repo, other team members will be able to use the exact same environment you are using.