Indisponibilité de la forge le mardi 18 mars entre 12h et 14h UTC+1 pour une maintenance de sécurité. Les services d'IRD Forge seront coupés : interface web, dépôt git, intégration continue, pages. Merci pour votre patience et votre compréhension.
To make it easy for you to get started with GitLab, here's a list of recommended next steps.
Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
## Add your files
-[ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-[ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
This project is adapted from the original CNES S1tiling processing chain available here : https://github.com/CNES/S1Tiling.
For more documentation please refere to this repository.
-[ ] [Set up project integrations](https://forge.ird.fr/espace-dev/personnels/alexandre/s1tiling_jupyter/-/settings/integrations)
## Collaborate with your team
-[ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-[ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-[ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-[ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
## Test and Deploy
Use the built-in continuous integration in GitLab.
-[ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-[ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-[ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-[ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-[ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
***
# Editing this README
When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
## Eodag config file
This is an example of eodag configuration file
## Suggestions for a good README
Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
## Name
Choose a self-explaining name for your project.
## Description
Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
## Badges
On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
## Visuals
Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
## Installation
Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
## Usage
Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
## Support
Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
## Roadmap
If you have ideas for releases in the future, it is a good idea to list them in the README.
```
peps:
priority: # Lower value means lower priority (Default: 1)
search: # Search parameters configuration
download:
extract: # whether to extract the downloaded products (true or false).
outputs_prefix: # where to store downloaded products.
dl_url_params: # additional parameters to pass over to the download url as an url parameter
delete_archive: # whether to delete the downloaded archives (true or false, Default: true).
auth:
credentials:
username: your@email.com
password: password
```
## S1Processor config file
Extract of S1Processor.cfg.
This file contains settings for the input/output folders used by s1tiling, as well as the various processing parameters: date, tile, download, etc. The file is clearly annotated.
Folders output, s1images, srtm, eodag and eventually tmp must link to the host. With the below execution command it must be in "/home"
## Contributing
State if you are open to contributions and what your requirements are for accepting them.
```[Paths]
# Path for result tiled images
output : /home/data_out
For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
# Path to store the S1 images to be processed
s1_images : /home/raw
You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
# Path to SRTM files
srtm : /home/SRTM
## Authors and acknowledgment
Show your appreciation to those who have contributed to the project.
# Path to geoid model
# geoid_file : ./Geoid/egm96.grd
## License
For open source projects, say how it is licensed.
# Path to a temporary file
tmp : /home/tmp
# tmp : %(TMPDIR)s/s1tiling
```
## Execution
The main change from the original container is the integration of jupyter-lab. When executing the container, you need to assign a communication port to access Jupyter from your browser. To retrieve processed data more easily, we create a bind folder with the "--mount" command. In this folder, you'll place the SRTM folder containing the tiles in .hgt format, as well as the configuration files eodag.yml and S1Processor.cfg.
## Project status
If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
```
docker run -it -p 8888:8888 --mount type=bind,source="/path/to/target",target=/home s1tiling
