muscle up README.md with installtion process

README.md

@@ -1,15 +1,156 @@
+![banner](images/banner.png)
+
+**[Trawl Watch](https://twitter.com/TrawlWatch)** is an initiative launched by the **[Bloom Association](https://www.bloomassociation.org/en/)** to track and expose the most destructive fishing vessels. Inspired by L’[Avion de Bernard](https://www.instagram.com/laviondebernard/), which monitors the movements of private jets, Trawl Watch aims to make visible the impact of these massive trawlers on our oceans. These vessels, often referred to as mégachalutiers, deploy gigantic nets that can engulf marine life from the surface down to the ocean floor. The consequences are both ecological—as they devastate crucial nursery and breeding areas for marine animals—and social, as they deprive artisanal fishermen of a healthy marine ecosystem. The solution proposed by Bloom is to dismantle these industrial fishing ships and redistribute their quotas to small-scale fishers. A petition has been launched, and Bloom continues to track these megatrawlers while awaiting action from European institutions12.
+
+**Did you know that, in Europe, the largest fishing vessels, which represent 1% of the fleet, catch half of the fish?** These factory-vessels can measure up to 144 meters in length and catch 400,000 kilos of fish per day! This is as much as 1,000 small-scale fishing vessels in one day at sea.
+
+**These veritable sea monsters are devastating Europe’s biodiversity and coastlines.** It is important to measure the scale of the damage: about 20 of these factory-vessels can obliterate hundreds of thousands of marine animals and biodiversity treasures in one day, including in the so-called ‘Marine Protected Areas’ of French territorial waters, which are not protected at all.
+
+In addition, more and more ‘mega trawlers’ – vessels over 25 meters in length – come right up to the coast to fish, so close to the beaches that they can be observed from the shore. These industrial monsters were not designed to fish in coastal waters, where small artisanal fishers operate.
+
+## Installing a Trawl Watch with `venv` and `poetry`
+
+### Prerequisites:
+
+1. Python (≥ `3.10`) installed on your system.
+2. Ensure you have `venv` and [`poetry`](https://python-poetry.org/) installed. If not, you can install them using `pip`.
+
+```bash
+pip install poetry
+```
+
+### Steps:
+
+1. **Clone the GitHub Repository:**
+
+   Clone the GitHub repository you want to install locally using the `git clone` command.
+
+   ```bash
+   $ git clone https://github.com/dataforgoodfr/12_bloom.git
+   ```
+
+2. **Navigate to the Repository Directory:**
+
+   Use the `cd` command to navigate into the repository directory.
+
+   ```bash
+   $ cd 12_bloom/
+   ```
+
+3. **Set Up a Virtual Environment using `venv`:**
+
+Create a virtual environment using `venv` to isolate the dependencies for the project.
+
+```bash
+$ python -m venv venv
+```
+
+4. **Activate the Virtual Environment:**
+
+   Activate the virtual environment to work within its isolated environment.
+
+   On Windows:
+
+   ```bash
+   venv\Scripts\activate
+   ```
+
+   On Unix or MacOS:
+
+   ```bash
+   source venv/bin/activate
+   ```
+
+5. **Install Project Dependencies using `poetry`:**
+
+   Use `poetry` to install the project dependencies.
+
+   ```bash
+   poetry install
+   ```
+
+   This will read the `pyproject.toml` file in the repository and install all the dependencies specified.
+
+6. **(Optional) Install Development Dependencies:**
+
+   If there are separate dependencies for development, you can install them using:
+
+   ```bash
+   poetry install --dev
+   ```
+
+7. **Run the Project:**
+
+   After installing the dependencies, you can run the project using the appropriate commands specified in the repository's documentation or README file.
+
+   ```bash
+   poetry run <command_to_run_project>
+   ```
+
+8. **Deactivate the Virtual Environment:**
+
+   Once you're done working with the project, deactivate the virtual environment.
+
+   ```bash
+   deactivate
+   ```
+
+#### Additional Notes:
+
+- Ensure you are using the correct Python version specified by the repository, especially if it's mentioned in the `pyproject.toml` file.
+- Always refer to the repository's documentation or README file for any specific instructions or configurations required for setting up and running the project.
+
+This documentation provides a general guideline for setting up a project from a GitHub repository using `venv` and `poetry`. Adjustments may be needed based on the specific requirements and configurations of the repository you are working with.
+
+### Requirements
+
+### FAQ
+
+Suivre les trajectoires de milliers de bateaux de pêche en quasi temps réel afin de pouvoir analyser leurs pratiques de pêche dans des zones maritimes protégées (AMP) à partir de données GPS récupérées (via antennes satellites et/ou terrestres)
+
+- https://www.un.org/sustainabledevelopment/economic-growth/
+- https://www.un.org/sustainabledevelopment/climate-change/
+- https://www.un.org/sustainabledevelopment/oceans/
+
+- https://petitions.bloomassociation.org/en/stop-mega-trawlers/
+
+## Setting up your local development environment
+
+### FAQ
+
+## bloom data source
+
+## [Automatic identification system](https://en.wikipedia.org/wiki/Automatic_identification_system)
+
+limits:
+
+- out of range
+- intense traffic area
+- expensive
+
+- https://spire.com/maritime/
+
+## [Marine Protected Areas]
+
+- https://www.cell.com/one-earth/fulltext/S2590-3322(20)30150-0
+
+## [Shom](https://www.shom.fr/)
+
+pour visualiser les droits miles nautique et les droits historiques
+
 # Bloom Project
 
-This project is maintained by D4G in order to gather vessels data. 
+This project is maintained by D4G in order to gather vessels data.
 A cron job is launched every 15min, does calls to API and save the data in a Postgresql database.
 
 ## About directory architecture
+
 The domain directory ...
 The infra directory ...
 
-
 More information can be found there :
+
 1. [Database initialisation and versioning](./documentation/database_init.md)
 2. [Development environment](./documentation/dev_env.md)
 3. [Useful SQL examples](./documentation/sql_examples.md)
-4. [Data models](#todo)
+4. [Data models](#todo)

data/vessels_subset_02022024.csv

@@ -0,0 +1,11 @@
+"id","country_iso3","cfr","IMO","registration_number","external_marking","ship_name","ircs","mmsi","loa","type","mt_activated"
+621,"ESP","27678 ESP","8516043","3VI-5-1-15","3VI-5-1-15","PARADANTA PRIMERO","EAAB",224378000,"58.38",">25m",False
+784,"FRA","FRA000919999","9828936","919999","CC919999","SCOMBRUS","FLVN",226347000,"81.37",">25m",False
+795,"FRA","NLD198300393","8224406","716900","FC716900","PRINS BERNHARD","FKHH",227302000,"88.24",">25m",False
+835,"FRA","FRA000932206","9741097","932206","CC932206","GEVRED","FIUO",228066900,"77",">25m",False
+863,"FRA","FRA000914221","9352913","914221","MA914221","VENT DU NORD II","FMEU",228215800,"41.92",">25m",False
+920,"GBR",NULL,"9877389","GY127",NULL,"HENDRIKA JACOBA",NULL,232031183,NULL,"Demersal seiners",False
+1194,"NLD","FRA000544858","7928835","FRA000544858","SL-9","JOHANNA","PHOE",244938000,"34.3",">25m",False
+1280,"NLD","NLD201001155","9599731","NLD201001155","UK-153","LUB SENIOR","PCGC",246749000,"28.5",">25m",False
+1431,"POL","IRL000I13000","9204556","PL02315","GDY-151","ANNELIES ILENA","SPG4839",261084090,"144.6",">25m",False
+1507,"PRT","PRT000023094","9297694","PTAVE-117345-N","PTAVE-117345-N","FRANÇA MORTE","CUFE7",263581000,"73.8",">25m",False

docs/.gitignore

@@ -0,0 +1,6 @@
+node_modules
+.dendron.*
+build
+seeds
+.next
+pods/service-connections

docs/dendron.code-workspace

@@ -0,0 +1,37 @@
+{
+  "folders": [
+    {
+      "path": "notes",
+      "name": "docs"
+    }
+  ],
+  "settings": {
+    "dendron.rootDir": ".",
+    "files.autoSave": "onFocusChange",
+    "pasteImage.path": "${currentFileDir}/assets/images",
+    "pasteImage.prefix": "/",
+    "markdown-preview-enhanced.enableWikiLinkSyntax": true,
+    "markdown-preview-enhanced.wikiLinkFileExtension": ".md",
+    "editor.snippetSuggestions": "inline",
+    "editor.suggest.snippetsPreventQuickSuggestions": false,
+    "editor.suggest.showSnippets": true,
+    "editor.tabCompletion": "on",
+    "dendron.enableSelfContainedVaultWorkspace": true
+  },
+  "extensions": {
+    "recommendations": [
+      "dendron.dendron",
+      "dendron.dendron-paste-image",
+      "dendron.dendron-markdown-shortcuts",
+      "redhat.vscode-yaml"
+    ],
+    "unwantedRecommendations": [
+      "dendron.dendron-markdown-links",
+      "dendron.dendron-markdown-notes",
+      "dendron.dendron-markdown-preview-enhanced",
+      "shd101wyy.markdown-preview-enhanced",
+      "kortina.vscode-markdown-notes",
+      "mushan.vscode-paste-image"
+    ]
+  }
+}

docs/dendron.yml

@@ -0,0 +1,108 @@
+version: 5
+dev:
+    enablePreviewV2: true
+    enableSelfContainedVaults: true
+commands:
+    lookup:
+        note:
+            selectionMode: extract
+            confirmVaultOnCreate: true
+            vaultSelectionModeOnCreate: smart
+            leaveTrace: false
+            bubbleUpCreateNew: true
+            fuzzThreshold: 0.2
+    randomNote: {}
+    insertNoteLink:
+        aliasMode: none
+        enableMultiSelect: false
+    insertNoteIndex:
+        enableMarker: false
+    copyNoteLink:
+        aliasMode: title
+    templateHierarchy: template
+workspace:
+    vaults:
+        -
+            fsPath: .
+            selfContained: true
+            name: docs
+    journal:
+        dailyDomain: daily
+        name: journal
+        dateFormat: y.MM.dd
+        addBehavior: childOfDomain
+    scratch:
+        name: scratch
+        dateFormat: y.MM.dd.HHmmss
+        addBehavior: asOwnDomain
+    task:
+        name: task
+        dateFormat: y.MM.dd
+        addBehavior: asOwnDomain
+        statusSymbols:
+            '': ' '
+            wip: w
+            done: x
+            assigned: a
+            moved: m
+            blocked: b
+            delegated: l
+            dropped: d
+            pending: 'y'
+        taskCompleteStatus:
+            - done
+            - x
+        prioritySymbols:
+            H: high
+            M: medium
+            L: low
+        todoIntegration: false
+        createTaskSelectionType: selection2link
+    graph:
+        zoomSpeed: 1
+        createStub: false
+    enableAutoCreateOnDefinition: false
+    enableXVaultWikiLink: false
+    enableRemoteVaultInit: true
+    enableUserTags: true
+    enableHashTags: true
+    workspaceVaultSyncMode: noCommit
+    enableAutoFoldFrontmatter: false
+    enableEditorDecorations: true
+    maxPreviewsCached: 10
+    maxNoteLength: 204800
+    enableFullHierarchyNoteTitle: false
+    enablePersistentHistory: false
+preview:
+    enableFMTitle: true
+    enableNoteTitleForLink: true
+    enableFrontmatterTags: true
+    enableHashesForFMTags: false
+    enablePrettyRefs: true
+    enableKatex: true
+    automaticallyShowPreview: false
+publishing:
+    enableFMTitle: true
+    enableNoteTitleForLink: true
+    enablePrettyRefs: true
+    enableKatex: true
+    copyAssets: true
+    siteHierarchies:
+        - root
+    writeStubs: false
+    siteRootDir: docs
+    seo:
+        title: Dendron
+        description: Personal Knowledge Space
+    github:
+        enableEditLink: true
+        editLinkText: Edit this page on GitHub
+        editBranch: main
+        editViewMode: tree
+    enableSiteLastModified: true
+    enableFrontmatterTags: true
+    enableHashesForFMTags: false
+    enableRandomlyColoredTags: true
+    enableTaskNotes: true
+    enablePrettyLinks: true
+    searchMode: search

docs/notes/root.md

@@ -0,0 +1,20 @@
+---
+id: sfuij8tbpdmv6gnsqqsb8qf
+title: Root
+desc: ''
+updated: 1708373223323
+created: 1708373223324
+---
+# Welcome to Dendron
+
+This is the root of your dendron vault. If you decide to publish your entire vault, this will be your landing page. You are free to customize any part of this page except the frontmatter on top.
+
+## Lookup
+
+This section contains useful links to related resources.
+
+- [Getting Started Guide](https://link.dendron.so/6b25)
+- [Discord](https://link.dendron.so/6b23)
+- [Home Page](https://wiki.dendron.so/)
+- [Github](https://link.dendron.so/6b24)
+- [Developer Docs](https://docs.dendron.so/)

docs/notes/root.schema.yml

@@ -0,0 +1,7 @@
+version: 1
+imports: []
+schemas:
+  - id: root
+    children: []
+    title: root
+    parent: root