Develop Sedona¶
Scala/Java developers¶
IDE¶
We recommend Intellij IDEA with Scala plugin installed.
Import the project¶
Choose Open
Go to the Sedona root folder (not a submodule folder) and choose open
The IDE might show errors
The IDE usually has trouble understanding the complex project structure in Sedona.
Fix errors by changing POM.xml
You need to comment out the following lines in pom.xml
at the root folder, as follows. Remember that you should NOT submit this change to Sedona.
<!-- <parent>-->
<!-- <groupId>org.apache</groupId>-->
<!-- <artifactId>apache</artifactId>-->
<!-- <version>23</version>-->
<!-- <relativePath />-->
<!-- </parent>-->
Reload POM.xml
Make sure you reload the POM.xml or reload the maven project. The IDE will ask you to remove some modules. Please select yes
.
The final project structure should be like this:
Run unit tests¶
Run all unit tests
In a terminal, go to the Sedona root folder. Run mvn clean install
. All tests will take more than 15 minutes. To only build the project jars, run mvn clean install -DskipTests
.
More details can be found on Compile Sedona
Run a single unit test
In the IDE, right-click a test case and run this test case.
The IDE might tell you that the PATH does not exist as follows:
Go to Edit Configuration
Append the submodule folder to Working Directory
. For example, incubator-sedona/sql
.
Re-run the test case. Do NOT right click the test case to re-run. Instead, click the button as shown in the figure below.
Python developers¶
More details to come.
IDE¶
We recommend PyCharm
Import the project¶
R developers¶
More details to come.
IDE¶
We recommend RStudio