-
-
Notifications
You must be signed in to change notification settings - Fork 126
Update Github front page #314
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
corentin-prigent
wants to merge
4
commits into
MmgTools:master
Choose a base branch
from
corentin-prigent:feature/front-page
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| custom: ['https://www.mmgtools.org/mmg-open-source-consortium'] | ||
| custom: ['https://mmgtools.org/consortium.html'] |
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,200 +1,8 @@ | ||
|
|
||
| <h1 align="center"> mmg - Surface and volume remeshers </h1> | ||
| <h3 align="center"> open source software for bidimensional and tridimensional surface and volume remeshing </h3> | ||
|
|
||
| <div align="center" markdown="1"> | ||
|
|
||
| [![Release][release-image]][releases] [![License][license-image]][license] | ||
|
|
||
| [release-image]: https://img.shields.io/github/v/release/MmgTools/mmg?color=blue&label=release&style=flat | ||
| [releases]: https://github.com/MmgTools/mmg/releases | ||
|
|
||
| [license-image]: https://img.shields.io/badge/license-LGPL-blue.svg?style=flat | ||
| [license]: https://github.com/MmgTools/mmg/blob/master/LICENSE | ||
|
|
||
| </div> | ||
| <div align="center"> | ||
| <img src="https://img.shields.io/static/v1?label=macOS&logo=apple&logoColor=white&message=support&color=success" alt="macOS support"> | ||
| <img src="https://img.shields.io/static/v1?label=Ubuntu&logo=Ubuntu&logoColor=white&message=support&color=success" alt="Ubuntu support"> | ||
| <img src="https://img.shields.io/static/v1?label=Windows&logo=windows&logoColor=white&message=support&color=success" alt="Windows support"> | ||
| </div> | ||
|
|
||
| --- | ||
|
|
||
| |**master branch (release)**|[![Build Status][master-build]][master-sq-build]|[![codecov][master-cov]][master-codecov-cov]| | ||
| |:---:|:---:|:---:| | ||
| |**develop branch**|[![Build Status][dev-build]][dev-sq-build]|[![Coverage][dev-cov]][dev-codecov-cov]| | ||
|
|
||
| [master-build]: https://github.com/MmgTools/mmg/actions/workflows/long-tests.yml/badge.svg?branch=master | ||
| [master-sq-build]: https://github.com/MmgTools/mmg/actions/workflows/long-tests.yml?query=branch%3Amaster | ||
|
|
||
| [master-cov]: https://codecov.io/gh/MmgTools/mmg/branch/master/graph/badge.svg?token=87eWTxuzIb | ||
| [master-codecov-cov]: https://codecov.io/gh/MmgTools/mmg | ||
|
|
||
| [dev-build]: https://github.com/MmgTools/mmg/actions/workflows/long-tests.yml/badge.svg?branch=develop | ||
| [dev-sq-build]: https://github.com/MmgTools/mmg/actions/workflows/long-tests.yml?query=branch%3Adevelop | ||
|
|
||
| [dev-cov]: https://codecov.io/gh/MmgTools/mmg/branch/develop/graph/badge.svg?token=87eWTxuzIb | ||
| [dev-codecov-cov]: https://codecov.io/gh/MmgTools/mmg | ||
|
|
||
| --- | ||
|
|
||
| Mmg provides 3 applications and 4 libraries: | ||
| * the **mmg2d** application and library: mesh generation from a set of edges, adaptation and optimization of a bidimensional triangulation, and isovalue discretization; | ||
| * the **mmgs** application and library: adaptation and optimization of a surface triangulation and isovalue discretization; | ||
| * the **mmg3d** application and library: adaptation and optimization of a tetrahedral mesh, isovalue discretization and lagrangian movement; | ||
| * the **mmg** library gathering the **mmg2d**, **mmgs** and **mmg3d** libraries. | ||
|
|
||
| [//]: # ( comment ) | ||
|
|
||
| ## Get and compile the mmg project | ||
| ### Needed tools | ||
| To get and build Mmg, you will need: | ||
| * **Git**: to download the code you will have to use a git manager. You can install a git manager from the link below but there are many other git clients that you can use: | ||
| * [Official Git client](https://git-scm.com/download) (command-line program) | ||
| * [GitKraken](https://www.gitkraken.com/) | ||
| * [SourceTree](https://www.sourcetreeapp.com/) | ||
|
|
||
| Note that if you uses Microsoft Visual Studio (Windows OS), you can simply activate the Git Module of the application. | ||
|
|
||
| * **CMake** : Mmg uses the CMake building system that can be downloaded on the | ||
| following web page: | ||
| [https://cmake.org/download/](https://cmake.org/download/). On Windows OS, | ||
| once CMake is installed, please <span style="color:red"> do not forget to | ||
| mark the option: | ||
| ``` | ||
| Add CMake to the system PATH for all users | ||
| ``` | ||
| </span> | ||
|
|
||
| ### Mmg download and compilation | ||
| #### Unix-like OS (Linux, MacOS...) | ||
|
|
||
| 1. Get the repository: | ||
| ``` | ||
| wget https://github.com/MmgTools/mmg/archive/master.zip | ||
| ``` | ||
|
|
||
| or | ||
|
|
||
| ``` | ||
| git clone https://github.com/MmgTools/mmg.git | ||
| ``` | ||
|
|
||
| The project sources are available under the **src/** directory, see: | ||
| * **src/mmg2d/** for files related to the mmg2d application; | ||
| * **src/mmgs/** for files related to the mmgs application; | ||
| * **src/mmg3d/** for files related to the mmg3d application; | ||
| * **src/common/** for files related to all three. | ||
|
|
||
| 2. Fast compilation (build **mmg2d**, **mmgs**, **mmg3d**, the mmg2d static library (**libmmg3d.a**), the mmgs static library (**libmmgs.a**), the mmg3d static library (**libmmg3d.a**) and the mmg static library (**libmmg.a**)) all at once: | ||
| ``` | ||
| cd mmg | ||
| mkdir build | ||
| cd build | ||
| cmake .. | ||
| make | ||
| make install | ||
| ``` | ||
|
|
||
| If the `make install` command fails, try to run the `sudo make install` command. | ||
| If you don't have root access, please refer to the [Installation section](https://github.com/MmgTools/Mmg/wiki/Setup-guide#iii-installation) of the [setup guide](https://github.com/MmgTools/Mmg/wiki/Setup-guide#setup-guide). | ||
|
|
||
| The **mmg2d**, **mmgs** and **mmg3d** applications are available under the `mmg2d_O3`, `mmgs_O3` and `mmg3d_O3` commands. | ||
|
|
||
| Note that if you use some specific options and want to set them easily, you can use a shell script to execute the previous commands. An example is provided [here](https://github.com/MmgTools/mmg/wiki/Configure-script-for-CMake-(UNIX-like-OS)). | ||
|
|
||
| #### Windows OS | ||
| The following compilation can be performed in any modern version of *Windows* | ||
| (AKA 7, 8, 8.1 and 10). A basic knowledge of Windows is assumed (execute | ||
| commands in cmd, create directories, etc...). | ||
|
|
||
| ##### Compile with VisualStudio | ||
|
|
||
| Universal windows platform development | ||
| 1. Get the **Visual Studio** software: it can be downloaded [here](https://www.visualstudio.com/downloads/); | ||
|
|
||
| 2. if not done during the previous step, download **C/C++** compilers: in the Visual Studio searching zone, search **C compiler** and install the **Visual C++ compilers and libraries** (individual componant) and the MSBuild componant; | ||
|
|
||
| 3. in the Visual Studio searching zone, search the **git** word and select the installation of the **GitHub extension for VisualStudio**; | ||
|
|
||
| 4. stay in VisualStudio and clone the Mmg repository from the following url: https://github.com/MmgTools/mmg.git; | ||
|
|
||
| 5. Use **CMake** to configure and generate your project. It can be done either with the graphic mode of CMake (you have to select the "VisualStudio" generator) or with a command line. In this case, it is highly recommended to specify that you intent to build a VisualStudio project. | ||
| For example, if you are using VisualStudio 2017: | ||
| ``` | ||
| cmake -G "Visual Studio 15 2017 Win64" ^ | ||
| configure | ||
| ``` | ||
|
|
||
| Note that you can use a script to make this step easier (an example of script is provided [here](https://github.com/MmgTools/mmg/wiki/Configure-script-for-CMake-(Windows-OS))). | ||
|
|
||
| Once the configuration script has finished without errors a `mmg.sln` file will be generated in the cmake_build directory. | ||
|
|
||
| 6. Double click this file and the visual studio project will open. Then choose the project configuration (Release, Debug...) and make sure that the project is set to Win32 or x64. | ||
| Finally, in order to compile Mmg, right click the `INSTALL` project and select the option `BUILD`. | ||
|
|
||
| ##### Compile with MinGW | ||
|
|
||
| 1. Get a **C Compiler**: | ||
| * **MinGW** can be downloaded [here](http://mingw.org/). We recommand to install the *mingw-developer-tools*, *mingw32-base*, *mingw32-gcc-fortran*, *mingw32-gcc-g++* and *msys-base* packages; | ||
| * Edit the environment variables and add MinGW in your **PATH** variable. It can be done in the **advanced system settings** panel. (note that you must modify the **PATH** variable, not **Path**); | ||
| * **MinGW** binaries are probably in `C:\MinGW\bin` | ||
| * the MinGW terminal is in `C:\MinGW\msys\1.0\msys` | ||
|
|
||
| 2. Clone the Mmg repository from the following url: https://github.com/MmgTools/mmg.git; | ||
|
|
||
| 3. Quit and restart the *CMake* application to take the PATH modification into account then use CMake to configure and generate your project (select the MinGW Makefiles generator of CMake). If you have installed the scotch libraries, you will need to set explicitely the libraries paths; | ||
| 4. Build the Mmg applications: in the minGW prompt (`C:\MinGW\msys\1.0\msys`) run: | ||
| ``` | ||
| mingw32-make | ||
| ``` | ||
|
|
||
| Again, if you use some specific options and want to make the CMake configuration step easier, you can use a batch script. An example script is provided [here](https://github.com/MmgTools/mmg/wiki/Configure-script-for-CMake-(Windows-OS)). | ||
|
|
||
| ## Documentation | ||
| ### Project web page | ||
| Actualities of the project and software tutorials can be found on the [mmgtools](http://www.mmgtools.org) web page. | ||
|
|
||
| ### Forum | ||
| Share your comments and issues with other members of the Mmg community on the [Mmg forum](https://forum.mmgtools.org/). | ||
|
|
||
| ### GitHub Wiki | ||
| More detailed information about the compilation and configuration of Mmg applications is available on the project [wiki](https://github.com/MmgTools/mmg/wiki). | ||
|
|
||
| ### Man pages | ||
| Man pages are available inside the **doc/man** directory: | ||
| * To see the **mmg2d** man page, just run `man ./doc/man/mmg2d.1.gz` | ||
| * To see the **mmgs** man page, run `man ./doc/man/mmgs.1.gz` | ||
| * To see the **mmg3d** man page, run `man ./doc/man/mmg3d.1.gz` | ||
|
|
||
| ### Code documentation | ||
| Run the `make doc` command to build the Doxygen documentation, after running `cmake` | ||
| with the option `-DBUILD_DOC=yes` if you did not already do so. | ||
| You may wish to adapt `build/Doxyfile` to your liking. | ||
| * To see the **mmg** documentation, open the file `<build>/doc/index.html`. | ||
|
|
||
| ## Platforms | ||
| The **mmg** applications are tested on OS X and on most of the Linux platforms. | ||
|
|
||
| ## Contributing | ||
| Your contributions to the **mmg** project are welcome. You can help us to improve | ||
| our code by many means: | ||
| * pull requests: please follow the [guidelines on the wiki](https://github.com/MmgTools/Mmg/wiki/Developers-wiki#pull-requests); | ||
| * feature requests: please use the [Mmg forum](https://forum.mmgtools.org/); | ||
| * bug reports: please use the [GitHub issue tracker](https://github.com/MmgTools/mmg/issues/new); | ||
|
|
||
| ## About the team | ||
| Mmg's current developers and maintainers are Charles Dapogny, Cécile Dobrzynski, Pascal Frey and Algiane Froehly. | ||
|
|
||
| Contact: [email protected] | ||
|
|
||
| ## License and copyright | ||
| Code is under the [terms of the GNU Lesser General Public License](https://raw.githubusercontent.com/MmgTools/mmg/master/LICENSE). | ||
|
|
||
| Copyright © Bx INP/Inria/UBordeaux/UPMC, 2004- . | ||
|
|
||
| ## Reference | ||
| [Tetrahedral remeshing in the context of large-scale numerical simulation and high performance computing - _G. Balarac, F. Basile, P. Bénard, F. Bordeu, J.-B. Chapelier, L. Cirrottola, G. Caumon, C. Dapogny, P. Frey, A. Froehly, G. Ghigliotti, R. Laraufie, G. Lartigue, C. Legentil, R. Mercier, V. Moureau, C. Nardoni, S. Pertant and M. Zakari_ - submitted, (2021)](https://membres-ljk.imag.fr/Charles.Dapogny/publis/mmgapp2.pdf) | ||
| This is the main repository of mmg, an open source software for bidimensional | ||
| and tridimensional surface and volume remeshing. | ||
|
|
||
| [Three-dimensional adaptive domain remeshing, implicit domain meshing, and applications to free and moving boundary problems - _C. Dapogny, C. Dobrzynski and P. Frey_ - April 1, 2014 - _JCP_](http://www.sciencedirect.com/science/article/pii/S0021999114000266) | ||
| For any information regarding, installation, use of, development and contribution in mmg, | ||
| please visit [mmgtools.org](https://www.mmgtools.org). | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.