... | ... | @@ -4,36 +4,30 @@ This project was initiated in order to revise, improve and enhance the code base |
|
|
|
|
|
### There are two major tasks to accomplish:
|
|
|
1. Refactoring and enhancement of the FAMER code (mainly responsible: Matthias, Abd)
|
|
|
2. Development of the FAMER service (mainly responsible: tba)
|
|
|
2. Development of the FAMER service / Integration in Gradoop Service (mainly responsible: tba)
|
|
|
|
|
|
### Development HowTo
|
|
|
* [The git development workflow](Git development)
|
|
|
* [Usage of the integrated Maven plugins](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Maven-plugins-checkstyle,-spotbugs-and-shade)
|
|
|
* [Test-driven development with JUnit](Test driven development)
|
|
|
* [CI/CD with GitLab](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Continuous-Integration,-Delivery-and-Deployment-with-GitLab)
|
|
|
* [Releases](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/FAMER-Releases)
|
|
|
* [The git development workflow](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Development/Git-workflow)
|
|
|
* [Usage of the integrated Maven plugins](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Development/Maven-plugins)
|
|
|
* [Test-driven development with JUnit](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Development/Test-driven-development)
|
|
|
* [CI/CD with GitLab](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Development/CI-CD-with-Gitlab)
|
|
|
* [Releases](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Development/FAMER-releases)
|
|
|
---------------------
|
|
|
### FAMER usage with JSON configuration
|
|
|
FAMER uses a configuration file to define the single tasks like linking and clustering. Those input configuration is based on JSON, the documentation and usage can be find here and will be progressively completed and adapted to the current code.
|
|
|
|
|
|
An executable FAMER JAR can be build with maven in a local `build` directory, see [here](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Maven-plugins-checkstyle,-spotbugs-and-shade#maven-shade-plugin-for-jar-building) for how it is build and more information. Use this JAR to run a Flink job (see [here](https://ci.apache.org/projects/flink/flink-docs-stable/ops/cli.html) or [here](https://ci.apache.org/projects/flink/flink-docs-stable/getting-started/tutorials/local_setup.html) for details). Pass the path to the JSON config file as command line argument, e.g.:
|
|
|
An executable FAMER JAR can be build with maven in a local `build` directory, see [here](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Development/Maven-plugins#maven-shade-plugin-for-jar-building) for how it is build and more information. Use this JAR to run a Flink job (see [here](https://ci.apache.org/projects/flink/flink-docs-stable/ops/cli.html) or [here](https://ci.apache.org/projects/flink/flink-docs-stable/getting-started/tutorials/local_setup.html) for details). Pass the path to the JSON config file as command line argument, e.g.:
|
|
|
|
|
|
> `./bin/flink run path/to/famer-0.1.0-SNAPSHOT-executable.jar path/to/famer-config.json`
|
|
|
|
|
|
**Important Note:** Since the configuration is parsed from a JSON file, the following must be considered when using FAMER on Windows systems. File paths on Windows systems are specified with "backslash" (`\`) , e.g: `C:\path\to\graph`. However, the "backslash" is used as an escape character in JSON format, so on Windows systems the paths provided in the JSON configuration file must be double-escaped in order to be parsed validly: `C:\\path\\to\\graph`.
|
|
|
|
|
|
* [JSON configuration and documentation - overall structure](Overall-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation - overall structure](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Configuration/Overall-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-preProcessing](PreProcessing-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-linking](Linking-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-clustering](Clustering-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-incremental](Incremental-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-postProcessing](PostProcessing-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-linking](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Configuration/Linking-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-clustering](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Configuration/Clustering-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-incremental](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Configuration/Incremental-Configuration-(JSON))
|
|
|
* [JSON configuration and documentation for famer-postProcessing](https://git.informatik.uni-leipzig.de/dbs/FAMER/-/wikis/Home/Configuration/PostProcessing-Configuration-(JSON))
|
|
|
---------------------
|
|
|
## Organization and Meetings
|
|
|
* there is a Slack-workspace, please contact [Matthias](mailto:taeschner@informatik.uni-leipzig.de) to get an invitation
|
|
|
---------------------
|
|
|
* [02.07.2019 - meeting and results](Initial Meeting 02.07.2019)
|
|
|
* [16.07.2019 - meeting and results](Meeting 16.07.2019)
|
|
|
* [17.09.2019 - meeting and results](Meeting 17.09.2019)
|
|
|
|
|
|
### Next meeting: tba |
|
|
\ No newline at end of file |
|
|
* there is a Slack-workspace, please contact [Matthias](mailto:taeschner@informatik.uni-leipzig.de) to get an invitation |
|
|
\ No newline at end of file |