You can also specify your install directory with `-DCMAKE_INSTALL_PREFIX=/path/to/your/install` and then
call `make install`
## Using ScalFMM in your project
#### Build the doc:
To find ScalFMM, `pkgconfig` can be used within your CMake and all ScalFMM dependencies will be found automatically.
Here is an example :
```cmake
find_package(scalfmm CONFIG REQUIRED)
if(scalfmm_FOUND)
message(STATUS "ScalFMM Found")
add_executable(my_exe program.cpp )
target_link_libraries(my_exe scalfmm::scalfmm)
else()
message(FATAL_ERROR "ScalFMM NOT FOUND")
endif()
```
## Documentation
The doc can be found [here](https://solverstack.gitlabpages.inria.fr/ScalFMM/) or you can build it locally.
```bash
```bash
cd scalfmm/Build
cd scalfmm/Build
...
@@ -78,25 +108,31 @@ cmake .. -DSCALFMM_BUILD_DOC=ON # or if cmake has already been called, ccmake .
...
@@ -78,25 +108,31 @@ cmake .. -DSCALFMM_BUILD_DOC=ON # or if cmake has already been called, ccmake .
make doc
make doc
```
```
This will generate the documentation in HTML format in the `Build/Doc/html` folder. You can create a local server to access it using Python
This will generate the documentation in HTML format in the `Build/Doc/html` folder.
```bash
```bash
# From the Build folder
# From the Build folder
cd Doc/html
cd Doc/html
python3 -m http.server # or python2 -m SimpleHTTPServer
firefox index.html
```
```
## Contributing and development guidelines
### Gitlab flow
The documentation can then be accessed from an internet browser at the address `localhost:8000`.
Please, read the Gitlab flow article available [here](https://docs.gitlab.com/ee/workflow/gitlab_flow.html<Paste>).
To make it simple, if you want to contribute to the library, create a branch from `master` with a meaningful name and develop
your feature in that branch. Keep your branch up to date by regularly rebasing your branch from the `master` branch to be up
to date. Once your are done, send a merge request.
### Help and News
## Help and News
You can subscribe to the scalfmm-public-users@lists.gforge.inria.fr mailing list (http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/scalfmm-public-users). The list is very low trafic (~ 2 mails per year), we will let you know of improvements and releases.
You can subscribe to the scalfmm-public-users@lists.gforge.inria.fr mailing list (http://lists.gforge.inria.fr/cgi-bin/mailman/listinfo/scalfmm-public-users). The list is very low trafic (~ 2 mails per year), we will let you know of improvements and releases.
Contact the developers at : scalfmm-public-support@lists.gforge.inria.fr
Contact the developers at : scalfmm-public-support@lists.gforge.inria.fr
