tutorials/workshops/bids23/06_contributing.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Getting Involved"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "If you want to get involved in the project we recommend to:\n",
    "\n",
    "1. Join the Discord server: [https://discord.gg/hYxc5AJB92](https://discord.gg/hYxc5AJB92)\n",
    "\n",
    "Here is where we will manage all the communications regarding EOTDL as well as provide support to users and developers.\n",
    "\n",
    "2. Engage in GitHub [https://github.com/earthpulse/eotdl](https://github.com/earthpulse/eotdl) issues.\n",
    "\n",
    "Features to be implemented will be posted as issues in the GitHub repository. You can comment on them, propose alternative solutions, or even propose new features. The most liked features will have priority in the development roadmap."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# Contributing"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Datasets and Models"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The most straightforward way to contribute to EOTDL is with datasets and models. \n",
    "\n",
    "Feel free to upload your own datasets and models and share them with the community.\n",
    "\n",
    "Otherwise, pick a dataset or model from the list of issues in GitHub: [https://github.com/earthpulse/eotdl/issues](https://github.com/earthpulse/eotdl/issues)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Third Party Applications"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "If you want to build an application on top of EOTDL, please let us know in the Discord server. We will be happy to help you and promote your application. Some ideas of applications that can be built on top of EOTDL are:\n",
    "\n",
    "- Third party repositories of datasets and models\n",
    "- Datasets visualization dashboards\n",
    "- AutoML platforms\n",
    "- Labelling tools\n",
    "- Educational applications\n",
    "- Model interpretability platforms\n",
    "- Subscription services"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "## Codebase"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "Contributing to the codebase is a bit more complex. However, if you are determined to do so, you should follow these steps:\n",
    "\n",
    "1. Join the [Discord](https://discord.gg/hYxc5AJB92) server and request the `devleoper` status. This will grant you access to the private channels where we discuss the development of EOTDL.\n",
    "2. Attend feature planning meetings. These are held periodically (and will be announced in Discod). Here we discuss the features to be implemented in the next release, who will be in charge of each feature, and the deadline for each release.\n",
    "3. Fork the repository and create a new branch for each feature you are working on.\n",
    "4. Once you have finished the feature, create a pull request to the `develop` branch of the main repository.\n",
    "5. The pull request will be reviewed by the maintainers and, if everything is correct, it will be merged into the `develop` branch.\n",
    "\n",
    "Once the `develop` branch has enough features to be released, a new release will be created and merged into the `main` branch."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Running EOTDL locally"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "After forking the repository, clone it to your local machine.\n",
    "\n",
    "If you encounter any issue running EOTDL locally, please get in touch with use through Discord so we can assist you."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### API"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "You can run the API with Docker.\n",
    "\n",
    "```\n",
    "docker-compose up\n",
    "```\n",
    "\n",
    "This will start the API, a MongoDB instance, and a Minio instance.\n",
    "\n",
    "> The db must be initialized with a couple of collections, you can check the `/admin/init-db` endpoint to do so."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### CLI"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "When developing the CLI, you may need to export the URL of the API.\n",
    "\n",
    "```\n",
    "export EOTDL_API_URL=http://localhost:8000\n",
    "```\n",
    "\n",
    "Or whatever port the API is running (set in the `docker-compose.yml` file). Otherwise, it will communicate with the production API.\n",
    "\n",
    "Depending on the features you are working on (mainly if it requires changes on the API) you will have to do this or not.\n",
    "\n",
    "Then, you can run the CLI with the command\n",
    "\n",
    "```\n",
    "python eotdl/main.py --help\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### Library"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The library is the ideal place to implement additional data access services, data curation mechanisms, data processing or visualization tools, feature engineering, etc. Feel free to bring your preferred tools and techniques to the library!\n",
    "\n",
    "Again, you may need to export the URL of the API if you are working on features that require changes on the API."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "#### User Interface"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "The user interface is a [SvelteKit](https://kit.svelte.dev/) application. You can run it with the command\n",
    "\n",
    "```\n",
    "yarn dev\n",
    "```\n",
    "\n",
    "You will need to install dependencies the first time you run it.\n",
    "\n",
    "```\n",
    "yarn install\n",
    "```\n",
    "\n",
    "Again, if you want to work with a local version of the API, you will need to set the appropriate URL in the `.env` file."
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "### Third party Services"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "In order to run EOTDL, the following third party services are required:\n",
    "\n",
    "- [Auth0](https://auth0.com/) is used for authentication. You will need to set the appropriate environment variables in the `.env` files.\n",
    "- [EOXHub](https://eox.at/) is used as a provisioning service for `SentinelHUB` and `GeoDB`. If you need to interact with it, please get in touch with us through Discord for further instructions."
   ]
  }
 ],
 "metadata": {
  "language_info": {
   "name": "python"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}