nojhan/paradiseo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix factual errors in README, INSTALL, and CONTRIBUTING

Browse source 
- Fix cmake typo: -BUILD_TESTING → -DBUILD_TESTING (CONTRIBUTING.md)
- Remove dead GForge clone URL and mailing list links
- Replace mailing list references with GitHub Issues
- Drop outdated Ubuntu version and GCC version specifics (18.04/12.04,
  g++-8/gcc-4.7) — ParadisEO requires C++17, any modern compiler works
- Fix doc-edo label: "for MO" → "for EDO" (INSTALL.md)
- Fix doc path: build/paradise-mo/doc → build/mo/doc (INSTALL.md)
- Fix website path: paradiseo/website/index.html → docs/index.html (README.md)
- Update Git clone URL from dead INRIA GForge to GitHub (README.md)
This commit is contained in:
Eremey Valetov 2026-02-28 19:20:18 -05:00
commit df7db10377
3 changed files with 18 additions and 29 deletions
Download patch file Download diff file Expand all files Collapse all files

11
CONTRIBUTING.md
View file

@ -19,9 +19,8 @@ Contribution Workflow
The maintainer(s) will try to answer under a couple of weeks, if not, do not hesitate to send an e-mail. The maintainer(s) will try to answer under a couple of weeks, if not, do not hesitate to send an e-mail.
If you're not familiar with Git and merge requests, start by cloning one of the main repository: If you're not familiar with Git and merge requests, start by cloning the main repository:
- `git clone https://github.com/nojhan/paradiseo.git` - `git clone https://github.com/nojhan/paradiseo.git`
- `git clone https://scm.gforge.inria.fr/anonscm/git/paradiseo/paradiseo.git`
Git workflow Git workflow
@ -38,7 +37,7 @@ git checkout -b <my_feature> # Always work on a dedicated branch.
git commit <whatever> git commit <whatever>
mkdir build mkdir build
cd build cd build
cmake -DCMAKE_BUILD_TYPE=Debug -BUILD_TESTING=ON -DENABLE_CMAKE_TESTING=ON .. && make && ctest # Always test. cmake -DCMAKE_BUILD_TYPE=Debug -DBUILD_TESTING=ON -DENABLE_CMAKE_TESTING=ON .. && make && ctest # Always test.
cd .. cd ..
git pull origin master # Always check that your modification still merges. git pull origin master # Always check that your modification still merges.
``` ```
@ -46,7 +45,7 @@ git pull origin master # Always check that your modification still merges.
If everything went without error, you can either send the patch or submit a merge request. If everything went without error, you can either send the patch or submit a merge request.
To do so, you can either: To do so, you can either:
- submit a "pull request" on Github: [nojhan/paradiseo](https://github.com/nojhan/paradiseo), - submit a "pull request" on Github: [nojhan/paradiseo](https://github.com/nojhan/paradiseo),
- or send a patch on the [ParadisEO mailing list](https://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/paradiseo-users). - or [open an issue](https://github.com/nojhan/paradiseo/issues) to discuss your proposed changes.
See below for the details. See below for the details.
@ -79,6 +78,6 @@ git pull origin master
git diff master <my_feature> > my_feature.patch git diff master <my_feature> > my_feature.patch
``` ```
Then send the `my_feature.patch` (along with your explanations about why the maintainer should merge your modifications) Then [open an issue](https://github.com/nojhan/paradiseo/issues) with `my_feature.patch` attached
to the [mailing list](https://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/paradiseo-users). (along with your explanations about why the maintainer should merge your modifications).

26
INSTALL.md
View file

@ -9,9 +9,9 @@ Just put it somewhere on your development computer, compile it from here and ind
Build Build
----- -----
Paradiseo is mainly developed for Linux, on which it is straightforward to install a C++ build chain. For example, on Ubuntu 18.04: Paradiseo is mainly developed for Linux, on which it is straightforward to install a C++ build chain. For example, on Ubuntu:
```bash ```bash
sudo apt install g++-8 cmake make libeigen3-dev libopenmpi-dev doxygen graphviz libgnuplot-iostream-dev sudo apt install g++ cmake make libeigen3-dev libopenmpi-dev doxygen graphviz libgnuplot-iostream-dev
``` ```
Paradiseo use the CMake build system, so building it should be as simple as: Paradiseo use the CMake build system, so building it should be as simple as:
@ -67,7 +67,7 @@ Feel free to test with another compiler and to send us your report.
As of today, we cannot guarantee that it will be easy to As of today, we cannot guarantee that it will be easy to
install ParadisEO under Windows if you're a beginner. install ParadisEO under Windows if you're a beginner.
There is still some (possibly outdated) help about oldest version on the [Website](http://paradiseo.gforge.inria.fr/). There is still some (possibly outdated) help about oldest version on the [Website](https://nojhan.github.io/paradiseo/).
If you know how to install a working compiler and the dependencies, If you know how to install a working compiler and the dependencies,
you may follow the same steps than the Linux process below. you may follow the same steps than the Linux process below.
@ -89,9 +89,9 @@ Some features are only available if some dependencies are installed:
- Doxygen is needed to build the API documentation, and you should also install graphviz if you want the class relationship diagrams. - Doxygen is needed to build the API documentation, and you should also install graphviz if you want the class relationship diagrams.
- GNUplot is needed to have the… GNUplot graphs at checkpoints. - GNUplot is needed to have the… GNUplot graphs at checkpoints.
To install all those dependencies at once under Ubuntu (18.04), just type: To install all those dependencies at once under Ubuntu, just type:
```bash ```bash
sudo apt install g++-8 cmake make libeigen3-dev libopenmpi-dev doxygen graphviz libgnuplot-iostream-dev. sudo apt install g++ cmake make libeigen3-dev libopenmpi-dev doxygen graphviz libgnuplot-iostream-dev
``` ```
@ -144,20 +144,10 @@ this can be helpful if you don't need other modules with more complex dependenci
Shared Memory Processing (SMP) module Shared Memory Processing (SMP) module
------------------------------------- -------------------------------------
The SMP module requires gcc 4.7 or higher. This is due to the fact that it uses the new C++ standard. ParadisEO requires C++17, so any modern compiler (GCC, Clang) should work.
At the moment, the SMP module does not work on Windows or Mac OS X since MinGW does not provide support for std::thread and Apple does not supply a recent version of gcc (but you can try to compile gcc 4.7 by yourself).
To enable the compilation of the SMP module, just set the `SMP` option. To enable the compilation of the SMP module, just set the `SMP` option.
Depending on your distribution, you might have to give to CMake the path of gcc and g++ 4.7.
This is the case for Ubuntu 12.04 LTS for instance.
If you are in that case and assuming you have a standard path for gcc et g++ 4.7:
```bash
cmake .. -DSMP=true -DCMAKE_C_COMPILER=/usr/bin/gcc-4.7 -DCMAKE_CXX_COMPILER=/usr/bin/g++-4.7
```
Estimating Distribution Objects (EDO) module Estimating Distribution Objects (EDO) module
-------------------------------------------- --------------------------------------------
@ -178,12 +168,12 @@ Targets for the build system (usually `make`) are:
- `doc` for all documentations, - `doc` for all documentations,
- `doc-eo` for building EO documentation, - `doc-eo` for building EO documentation,
- `doc-mo` for MO, - `doc-mo` for MO,
- `doc-edo` for MO, - `doc-edo` for EDO,
- `doc-moeo` for MOEO, - `doc-moeo` for MOEO,
- `doc-smp` for SMP. - `doc-smp` for SMP.
Each documentation are generated separatly in the module build folder. Each documentation are generated separatly in the module build folder.
For instance, after the generation of the MO documentation, you will find it in `build/paradise-mo/doc`. For instance, after the generation of the MO documentation, you will find it in `build/mo/doc`.
Examples Examples
-------- --------

10
README.md
View file

@ -16,8 +16,8 @@ It focus on the efficiency of the implementation of solvers, by providing:
# Very Quick Start # Very Quick Start
1. Use a recent Linux, like an Ubuntu. 1. Use a recent Linux, like Ubuntu.
2. `sudo apt install g++-8 cmake make libeigen3-dev libopenmpi-dev doxygen graphviz libgnuplot-iostream-dev` 2. `sudo apt install g++ cmake make libeigen3-dev libopenmpi-dev doxygen graphviz libgnuplot-iostream-dev`
3. From the Paradiseo directory: `mkdir build ; cd build ; cmake -D CMAKE_BUILD_TYPE=Release -DEDO=ON .. && make -j` 3. From the Paradiseo directory: `mkdir build ; cd build ; cmake -D CMAKE_BUILD_TYPE=Release -DEDO=ON .. && make -j`
4. Copy-paste this CMA-ES code in `cmaes.cpp`: 4. Copy-paste this CMA-ES code in `cmaes.cpp`:
```cpp ```cpp
@ -173,7 +173,7 @@ Stable versions should however work on Windows and any Unix-like operating syste
# Code # Code
The latest stable version is on the official Git repository of INRIA: `git clone git://scm.gforge.inria.fr/paradiseo/paradiseo.git` The latest version is on the official Git repository: `git clone https://github.com/nojhan/paradiseo.git`
## Dependencies ## Dependencies
@ -187,7 +187,7 @@ Some features are only available if some dependencies are installed:
- Doxygen is needed to build the API documentation, and you should also install graphviz if you want the class relationship diagrams. - Doxygen is needed to build the API documentation, and you should also install graphviz if you want the class relationship diagrams.
- GNUplot is needed to have the… GNUplot graphs at checkpoints. - GNUplot is needed to have the… GNUplot graphs at checkpoints.
To install all those dependencies at once under Ubuntu (18.04), just type: `sudo apt install g++-8 cmake make libeigen3-dev libopenmpi-dev doxygen graphviz libgnuplot-iostream-dev`. To install all those dependencies at once under Ubuntu, just type: `sudo apt install g++ cmake make libeigen3-dev libopenmpi-dev doxygen graphviz libgnuplot-iostream-dev`.
## Compilation ## Compilation
@ -237,7 +237,7 @@ benchmark libraries are in `paradiseo/problems`.
For academic articles, books, more tutorials, presentations slides, For academic articles, books, more tutorials, presentations slides,
real life example of solvers and contact information, real life example of solvers and contact information,
please see the web site (available in `paradiseo/website/index.html`). please see the web site (available in `docs/index.html`).
# Citing Paradiseo # Citing Paradiseo