/netcdf-assembler

A program for assembling multiple NetCDF (and GRIB) files into one large NetCDF file.

Primary LanguageC++

📚 netcdf-assembler 🗺️

Table of contents 📑

Description 📝

The netcdf-assembler is a project from my internship at Seagnal, during my 2nd year in EPITECH Grand Ecole program.
Its purpose is to create in C++ a program for assembling multiple NetCDF (and GRIB) files into one large NetCDF file.

Usage ⚔️

You can run netcdf-assembler like this :

./netcdf-assembler result_file.nc part1.nc part2.nc part3.nc

For more information, please see the help section.

> ./netcdf-assembler --help
Usage: ./netcdf-assembler output_file files

DESCRIPTION
        Assembles multiple NetCDF (and GRIB) files into one large NetCDF file.

Compilation 🛠️

NetCDF lib is required to compile the project.

You can compile the project with this command :

make

If you want to debug the program, you can compile the project with this :

make debug

If you want clean the project, you can run this command :

make fclean

You can clean and compile the project with make re and for debugging make re_debug

Documentation 📚

The documentation is accessible here.

You can generate the documentation with this command :

make doc

You need multiple package for generate them :

  • doxygen
  • doxygen-latex
  • doxygen-doxywizard
  • graphviz

Code mandatory 📦

  • You'll need to create a branch where you'll push your code. Once you've completed your tasks on this branch, we'll work together to merge it and check that everything works.
  • Every function you add must be documented and code-style with Seagnal's coding style.
  • If the github actions don't succeed, then ask yourself some questions
  • Each commit will contain [+] or [-] or [~] followed by a message
    • [+] : Add feature
    • [-] : Delete feature
    • [~] : Edit feature

Of course, in exceptional cases, we may depart from these rules.

Contributors 👤

This project was carried out alone by Nicolas TORO.