Some ocean processing and simulation tools, initially designed to work with optical imagery ... but expanded to work with altimetry, CFOSAT, SWOT. Their common point: use of geometrical optics approximation for investigating / processing the effects of wind-generated surface gravity waves in various types of data.
Main contributors: Fabrice Ardhuin Marine De Carlo
These tools have been used for the following papers:
https://doi.org/10.1029/2021JC017342 Total Surface Current Vector and Shear from a Sequence of Satellite images: Effect of Waves in Opposite Directions
https://doi.org/10.1029/2023JC019740 Wave groups and small scale variability of wave heights observed by altimeters
https://doi.org/10.13140/RG.2.2.17300.27529 Along-track resolution and uncertainty of altimeter-derived wave height and sea level: re-defining the significant wave height in extreme storms
git clone --quiet https://gitlab.ifremer.fr/fa1e926/optools
MATLAB folder contains some of the original codes, in particular you can
I) test the principle of 3-image method using 1D data and Monte-Carlo simulations to check for averaging effect and random errors opposite_test
II) Simulate some satellite images and analyze the phase speeds
- define wave spectrum (here using buoy data) and wind and current ... [Efth,freq,dir2]=define_spectrum;
U10=6; d2r=pi/180; Udir=40.*d2r; % direction to, trig. convention Ux=0; Uy=0;
- simulate images , for example
phitrig =[ 148.1901 148.8061 149.4561 149.4561]; offspec=[8.9740 9.0674 9.1693 9.1693]; theta=[6.2804 6.2413 6.2114 6.2114]; imgtimes=[0 0.5 1 1]; [imgs, nx, ny, x, y, dx, dy ] = S2_simu(Efth,freq,dir2,U10,Udir,Ux,Uy,imgtimes,offspec,phitrig,theta,10,801 ,1000,0. ,0.,0.15,1);
3.a S2_3ana : this is the 3-image method of Ardhuin et al. (2021) : this is super-slow.
3.b S2_analysis : standard 2-image phase difference method
III) Read a piece of Sentinel 2 imagery and do the same kind of analysis
-
load image (here this is just a small piece to make the tar not too big) load S2img
-
Run analysis
2.a S2_3ana : this is the 3-image method of Ardhuin et al. (2021) : this is super-slow.
for running on datarmor you may need to : git clone https://gitlab.ifremer.fr/fa1e926/optools OPTOOLS cd OPTOOLS/PYTHON module load conda/latest pip install rasterio python
Would be nice to add a few notebooks that do the same things as the matlab script described above ..
- Create or upload files
- Add files using the command line or push an existing Git repository with the following command:
cd existing_repo
git remote add origin https://gitlab.ifremer.fr/fa1e926/optools.git
git branch -M main
git push -uf origin main
- Invite team members and collaborators
- Create a new merge request
- Automatically close issues from merge requests
- Enable merge request approvals
- Automatically merge when pipeline succeeds
Use the built-in continuous integration in GitLab.
- Get started with GitLab CI/CD
- Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)
- Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy
- Use pull-based deployments for improved Kubernetes management
- Set up protected environments
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.
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.
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.
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.
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.
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.
If you have ideas for releases in the future, it is a good idea to list them in the README.
State if you are open to contributions and what your requirements are for accepting them.
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.
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.
Show your appreciation to those who have contributed to the project.
For open source projects, say how it is licensed.
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.