diff --git a/BUILDING.txt b/BUILDING.txt deleted file mode 100644 index cfd8dbbc2df1c1974aedefbcf96cc27bc9b15115..0000000000000000000000000000000000000000 --- a/BUILDING.txt +++ /dev/null @@ -1,26 +0,0 @@ -Rugged can be built from source either using maven 3 or eclipse. - -Building with Maven 3: - - Maven 3 can be downloaded here: - http://maven.apache.org/download.html - - If you are behind a proxy (which is a traditional - setting in a corporate environment), then you need - to configure maven to use it. This is explained - in the maven documentation here: - http://maven.apache.org/guides/mini/guide-proxies.html - - run "mvn package" to automatically download all - the required dependencies listed in the pom.xml file - and create a file named target/rugged-x.y.jar where - x.y is the version number - -Building with Eclipse: - - Eclipse can be downloaded here: - http://www.eclipse.org/downloads/ - - using your operating system tools, unpack the source distribution directly - inside your Eclipse workspace - - using Eclipse, import the project by selecting in the top level "File" menu - the entry "Import..." - - in the wizard that should appear, select "Maven -> Existing Maven Projects" - - select the folder you just created in your workspace by unpacking the - source distribution. The "pom.xml" file describing the project will be - automatically selected. Click finish diff --git a/src/changes/changes.xml b/src/changes/changes.xml index a576a7a3f80391f86100218f9cdc128038627f27..84a1ffaf3d018b3afb2957db20d2fffd4dae4498 100644 --- a/src/changes/changes.xml +++ b/src/changes/changes.xml @@ -21,9 +21,34 @@ </properties> <body> <release version="2.2-SNAPSHOT" date="TBD" description="TBD"> - <action dev="guylaine" type="update"> + <action dev="guylaine" type="update" issue="383"> Updated dependencies to Orekit 10.2 (and Hipparchus 1.7). </action> + <action dev="guylaine" type="fix" issue="384"> + Add connection with Gitlab CI to allow automatic building and release, + as well as automatic code analysis. + </action> + <action dev="luc" type="fix" issue="386"> + Fix a unit test due to CI specificity. + </action> + <action dev="guylaine" type="update"> + Update building explanations (.md) and remove redundant BUILDING.txt + </action> + <action dev="guylaine" type="update"> + Update deprecated method of Orekit DataProvidersManager class. + </action> + <action dev="guylaine" type="update" issue="382"> + Remove explicit dependency to Hipparchus library. + </action> + <action dev="guylaine" type="fix" issue="379"> + Correct erroneous Earth flattening for model IERS96 in RuggedBuilder. + </action> + <action dev="guylaine" type="update" issue="378"> + Replace in RuggedBuilder hard-coded constants by Orekit Earth constants. + </action> + <action dev="guylaine" type="add"> + Add package-info documentation. + </action> </release> <release version="2.1" date="2019-03-14" description="This is a minor release. diff --git a/src/site/markdown/building.md b/src/site/markdown/building.md index b9ce06623c376f10517cb57b576d8b116b1f54d3..071b221ffd03c93584f29758d5050f75db0f2f30 100644 --- a/src/site/markdown/building.md +++ b/src/site/markdown/building.md @@ -35,8 +35,9 @@ For systems not providing maven as a package, maven can be Apache Software Foundation. This site also explains the installation procedure. -As with all maven enabled projects, building Rugged is straightforward, simply -run: +As with all maven enabled projects, building official released versions of +Rugged is straightforward (see below for the special case of development versions), +simply run: mvn package @@ -46,12 +47,39 @@ the target directory, including one file named rugged-x.y.jar where x.y is the version number. This is the jar file you can use in your project using Rugged. +This command should always work for released Rugged versions as they +always depend only on released Orekit versions. Maven knows how +to download the pre-built binary for released Orekit versions. +The previous command may not work for development Rugged versions as they +may depend on unreleased Orekit versions. Maven cannot download +pre-built binaries for unreleased Orekit versions as none are +publicly available. In this case the command above will end with an error message +like: + + [ERROR] Failed to execute goal on project rugged: Could not resolve dependencies for project org.orekit:rugged:jar:X.x-SNAPSHOT: Could not find artifact org.orekit:orekit:jar:Y.y-SNAPSHOT + +In this case, you should build the missing Orekit artifact and +install it in your local maven repository beforehand. This is done by cloning +the Orekit source from Orekit git repository at Gitlab in some +temporary folder and install it with maven. This is done by +running the commands below (using Linux command syntax): + + git clone https://gitlab.orekit.org/orekit/orekit.git + cd orekit + git checkout -b develop origin/develop + mvn install + +Once the Orekit development version has been installed locally using +the previous commands, you can delete the cloned folder if you want. You can then +attempt again the mvn command at Rugged level, this time it should succeed as the +necessary artifact is now locally available. + If you need to configure a proxy server for dependencies retrieval, see the [Guide to using proxies](http://maven.apache.org/guides/mini/guide-proxies.html) page at the maven site. If you already use maven for your own projects (or simply eclipse, see -below), you may want to install rugged in your local repository. This is done +below), you may want to install rugged in your local maven repository. This is done with the following command: mvn install @@ -72,25 +100,27 @@ site at the [Eclipse Foundation](http://www.eclipse.org/downloads/). The simplest way to use Rugged with Eclipse is to follow these steps: - * unpack the distribution inside your Eclipse workspace + * using your operating system tools, unpack the source distribution directly + inside your Eclipse workspace. The source distribution file name has a name + of the form rugged-x.y-sources.zip where x.y is the version number. Unpacking + this zip file should create a folder of the form rugged-x.y in your workspace. + + + * using Eclipse, import the project by selecting in the top level "File" menu + the entry "Import..." + + * in the wizard that should appear, select "Maven -> Existing Maven Projects" - * create a new java project from existing sources and direct Eclipse to the - directory where you unpacked Rugged + * select the folder you just created in your workspace by unpacking the + source distribution. The "pom.xml" file describing the project will be + automatically selected. Click finish - * set the source folders to - * src/main/java - * src/test/java - * src/main/resources - * src/test/resources +The Rugged library should be configured automatically, including the dependency +to the underlying Orekit library. - in the source tab of the Configure Build Path dialog +Now you have an rugged-x.y project in you workspace, and you can create your +own application projects that will depend on the Rugged project. - * set the external libraries to JRE system library (provided by Eclipse), - Junit 4.x (provided by Eclipse), Hipparchus (available at - Hipparchus project - [downloads page](https://www.hipparchus.org/downloads.html)), - and Orekit (available at Orekit - [download page](https://www.orekit.org/download.html)) - in the libraries tab of the Configure Build Path dialog +You can also check everything works correctly by running the junit tests. [Top of the page](#top)