Skip to content

Commit

Permalink
Updated documentation for the release.
Browse files Browse the repository at this point in the history
  • Loading branch information
@BryanCazabonne
BryanCazabonne committed Oct 29, 2023
1 parent 9a1844b commit b3f7ddd
Show file tree
Hide file tree
Showing 5 changed files with 67 additions and 60 deletions.
114 changes: 57 additions & 57 deletions build.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,66 +2,66 @@

<project name="orekit" default="jar" basedir=".">

<property name="project.version" value="11.3.3" />
<property name="src.dir" location="src" />
<property name="main.src.dir" value="${src.dir}/main/java" />
<property name="main.resources.dir" value="${src.dir}/main/resources" />
<property name="test.src.dir" value="${src.dir}/test/java" />
<property name="test.resources.dir" value="${src.dir}/test/resources" />

<property name="build.dir" location="build" />
<property name="main.classes.dir" value="${build.dir}/classes" />
<property name="test.classes.dir" value="${build.dir}/test-classes" />
<property name="javadoc.dir" value="${build.dir}/javadoc" />
<property name="tests.reports" value="${build.dir}/test-reports" />

<property name="lib.dir" location="lib" />

<property name="hipparchus.version" value="3.0" />
<property name="hipparchus.core.jar" value="hipparchus-core-${hipparchus.version}.jar" />
<property name="hipparchus.geometry.jar" value="hipparchus-geometry-${hipparchus.version}.jar" />
<property name="hipparchus.ode.jar" value="hipparchus-ode-${hipparchus.version}.jar" />
<property name="hipparchus.fitting.jar" value="hipparchus-fitting-${hipparchus.version}.jar" />
<property name="hipparchus.optim.jar" value="hipparchus-optim-${hipparchus.version}.jar" />
<property name="hipparchus.filtering.jar" value="hipparchus-filtering-${hipparchus.version}.jar" />
<property name="hipparchus.stat.jar" value="hipparchus-stat-${hipparchus.version}.jar" />
<property name="hipparchus.maven.path" value="org/hipparchus" />
<property name="junit-jupiter.version" value="5.10.0" />
<property name="junit-jupiter-api.jar" value="junit-jupiter-api-${junit-jupiter.version}.jar" />
<property name="junit-jupiter-api.maven.path" value="org/junit/jupiter/junit-jupiter-api" />
<property name="junit-jupiter-engine.jar" value="junit-jupiter-engine-${junit-jupiter.version}.jar" />
<property name="junit-jupiter-engine.maven.path" value="org/junit/jupiter/junit-jupiter-engine" />
<property name="junit-platform.version" value="1.9.0" />
<property name="junit-platform-engine.jar" value="junit-platform-engine-${junit-platform.version}.jar"/>
<property name="junit-platform-engine.maven.path" value="org/junit/platform/junit-platform-engine" />
<property name="project.version" value="12.0-SNAPSHOT" />
<property name="src.dir" location="src" />
<property name="main.src.dir" value="${src.dir}/main/java" />
<property name="main.resources.dir" value="${src.dir}/main/resources" />
<property name="test.src.dir" value="${src.dir}/test/java" />
<property name="test.resources.dir" value="${src.dir}/test/resources" />

<property name="build.dir" location="build" />
<property name="main.classes.dir" value="${build.dir}/classes" />
<property name="test.classes.dir" value="${build.dir}/test-classes" />
<property name="javadoc.dir" value="${build.dir}/javadoc" />
<property name="tests.reports" value="${build.dir}/test-reports" />

<property name="lib.dir" location="lib" />

<property name="hipparchus.version" value="3.0" />
<property name="hipparchus.core.jar" value="hipparchus-core-${hipparchus.version}.jar" />
<property name="hipparchus.geometry.jar" value="hipparchus-geometry-${hipparchus.version}.jar" />
<property name="hipparchus.ode.jar" value="hipparchus-ode-${hipparchus.version}.jar" />
<property name="hipparchus.fitting.jar" value="hipparchus-fitting-${hipparchus.version}.jar" />
<property name="hipparchus.optim.jar" value="hipparchus-optim-${hipparchus.version}.jar" />
<property name="hipparchus.filtering.jar" value="hipparchus-filtering-${hipparchus.version}.jar" />
<property name="hipparchus.stat.jar" value="hipparchus-stat-${hipparchus.version}.jar" />
<property name="hipparchus.maven.path" value="org/hipparchus" />
<property name="junit-jupiter.version" value="5.10.0" />
<property name="junit-jupiter-api.jar" value="junit-jupiter-api-${junit-jupiter.version}.jar" />
<property name="junit-jupiter-api.maven.path" value="org/junit/jupiter/junit-jupiter-api" />
<property name="junit-jupiter-engine.jar" value="junit-jupiter-engine-${junit-jupiter.version}.jar" />
<property name="junit-jupiter-engine.maven.path" value="org/junit/jupiter/junit-jupiter-engine" />
<property name="junit-platform.version" value="1.9.0" />
<property name="junit-platform-engine.jar" value="junit-platform-engine-${junit-platform.version}.jar" />
<property name="junit-platform-engine.maven.path" value="org/junit/platform/junit-platform-engine" />
<property name="junit-platform-commons.jar" value="junit-platform-commons-${junit-platform.version}.jar" />
<property name="junit-platform-commons.maven.path" value="org/junit/platform/junit-platform-commons" />
<property name="junit-platform-commons.maven.path" value="org/junit/platform/junit-platform-commons" />
<property name="junit-platform-launcher.jar" value="junit-platform-launcher-${junit-platform.version}.jar"/>
<property name="junit-platform-launcher.maven.path" value="org/junit/platform/junit-platform-launcher" />
<property name="opentest4j.version" value="1.2.0" />
<property name="opentest4j.jar" value="opentest4j-${opentest4j.version}.jar" />
<property name="opentest4j.maven.path" value="org/opentest4j/opentest4j" />
<property name="apiguardian-api.version" value="1.1.2" />
<property name="apiguardian-api.jar" value="apiguardian-api-${apiguardian-api.version}.jar" />
<property name="apiguardian-api.maven.path" value="org/apiguardian/apiguardian-api" />
<property name="mockito.version" value="4.11.0" />
<property name="mockito.jar" value="mockito-core-${mockito.version}.jar" />
<property name="mockito.maven.path" value="org/mockito/mockito-core" />
<property name="bytebuddy.version" value="1.12.16" />
<property name="bytebuddy.jar" value="byte-buddy-${bytebuddy.version}.jar" />
<property name="bytebuddy.maven.path" value="net/bytebuddy/byte-buddy" />
<property name="bytebuddy.agent.jar" value="byte-buddy-agent-${bytebuddy.version}.jar" />
<property name="bytebuddy.agent.maven.path" value="net/bytebuddy/byte-buddy-agent" />
<property name="objenesis.version" value="3.2" />
<property name="objenesis.jar" value="objenesis-${objenesis.version}.jar" />
<property name="objenesis.maven.path" value="org/objenesis/objenesis" />
<property name="hamcrest.version" value="2.2" />
<property name="hamcrest.jar" value="hamcrest-${hamcrest.version}.jar" />
<property name="hamcrest.maven.path" value="org/hamcrest/hamcrest" />
<property name="maven.repository" value="https://repo1.maven.org/maven2" />
<property name="junit-platform-launcher.maven.path" value="org/junit/platform/junit-platform-launcher" />
<property name="opentest4j.version" value="1.2.0" />
<property name="opentest4j.jar" value="opentest4j-${opentest4j.version}.jar" />
<property name="opentest4j.maven.path" value="org/opentest4j/opentest4j" />
<property name="apiguardian-api.version" value="1.1.2" />
<property name="apiguardian-api.jar" value="apiguardian-api-${apiguardian-api.version}.jar" />
<property name="apiguardian-api.maven.path" value="org/apiguardian/apiguardian-api" />
<property name="mockito.version" value="4.11.0" />
<property name="mockito.jar" value="mockito-core-${mockito.version}.jar" />
<property name="mockito.maven.path" value="org/mockito/mockito-core" />
<property name="bytebuddy.version" value="1.12.16" />
<property name="bytebuddy.jar" value="byte-buddy-${bytebuddy.version}.jar" />
<property name="bytebuddy.maven.path" value="net/bytebuddy/byte-buddy" />
<property name="bytebuddy.agent.jar" value="byte-buddy-agent-${bytebuddy.version}.jar" />
<property name="bytebuddy.agent.maven.path" value="net/bytebuddy/byte-buddy-agent" />
<property name="objenesis.version" value="3.2" />
<property name="objenesis.jar" value="objenesis-${objenesis.version}.jar" />
<property name="objenesis.maven.path" value="org/objenesis/objenesis" />
<property name="hamcrest.version" value="2.2" />
<property name="hamcrest.jar" value="hamcrest-${hamcrest.version}.jar" />
<property name="hamcrest.maven.path" value="org/hamcrest/hamcrest" />
<property name="maven.repository" value="https://repo1.maven.org/maven2" />
<!-- Path to $JAVA_HOME/lib/tools.jar for compiler plugin -->
<property name="tools.jar" value="tools.jar" />
<property name="tools.path" value="lib" />
<property name="tools.jar" value="tools.jar" />
<property name="tools.path" value="lib" />


<property name="copyright" value="2002-2023 CS GROUP" />
Expand Down
5 changes: 4 additions & 1 deletion src/main/java/org/orekit/overview.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,7 @@ <h1>2. Features</h1>
<li>cartesian, elliptical Keplerian, circular and equinoctial parameters,
with non-Keplerian derivatives if available</li>
<li>Two-Line Elements (TLE)</li>
<li>Two-Line Elements generation using Fixed-Point algorithm or Least Squares Fitting</li>
<li>transparent conversion between all parameters</li>
<li>automatic binding with frames</li>
<li>attitude state and derivative</li>
Expand All @@ -85,6 +86,7 @@ <h1>2. Features</h1>
<li>covariance extrapolation using a Keplerian model</li>
<li>covariance frame transformation (inertial, Earth fixed, and local orbital frames)</li>
<li>covariance type transformation (cartesian, keplerian, circular, and equinoctial)</li>
<li>covariance interpolation based on the blending model</li>
</ul>
</li>
<li>Maneuvers
Expand Down Expand Up @@ -139,7 +141,7 @@ <h1>2. Features</h1>
<ul>
<li>central attraction</li>
<li>gravity models</li>
<li>J2-squared effect</li>
<li>J2-squared effect (Zeis model)</li>
<li>atmospheric drag</li>
<li>third body attraction</li>
<li>radiation pressure with eclipse</li>
Expand Down Expand Up @@ -368,6 +370,7 @@ <h1>2. Features</h1>
<li>loading of SEM and YUMA files for GPS constellation</li>
<li>exporting of ephemeris in CCSDS OEM and OCM file formats</li>
<li>loading of ILRS CPF orbit files</li>
<li>exporting of ephemeris in STK format</li>
</ul>
</li>
<li>Earth models
Expand Down
2 changes: 1 addition & 1 deletion src/site/markdown/downloads.md.vm
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ with groupID org.orekit and artifactId orekit so maven
internal mechanism will download automatically all artifacts and dependencies
as required.

#set ( $versions = {"11.3.3": "2023-06-30", "11.3.2": "2023-02-17", "11.3.1": "2022-12-24", "11.3": "2022-10-25", "11.2.1": "2022-08-01", "11.2": "2022-06-20", "11.1.2": "2022-04-27", "11.1.1": "2022-03-17", "11.1": "2022-02-14", "11.0.2": "2021-11-24", "11.0.1": "2021-10-22", "11.0": "2021-09-20", "10.3.1": "2021-06-16", "10.3": "2020-12-21", "10.2": "2020-07-14", "10.1": "2020-02-19", "10.0": "2019-06-24", "9.3.1": "2019-03-16", "9.3": "2019-01-25", "9.2": "2018-05-26","9.1": "2017-11-26","9.0.1": "2017-11-03","9.0": "2017-07-26","8.0.1": "2017-11-03","8.0": "2016-06-30","7.2.1": "2017-11-03","7.2": "2016-04-05","7.1": "2016-02-07","7.0": "2015-01-11","6.1": "2013-12-13","6.0": "2013-04-23","5.0.3": "2011-07-13","5.0.2": "2011-07-11","5.0.1": "2011-04-18"} )
#set ( $versions = {"12.0": "2023-11-05", "11.3.3": "2023-06-30", "11.3.2": "2023-02-17", "11.3.1": "2022-12-24", "11.3": "2022-10-25", "11.2.1": "2022-08-01", "11.2": "2022-06-20", "11.1.2": "2022-04-27", "11.1.1": "2022-03-17", "11.1": "2022-02-14", "11.0.2": "2021-11-24", "11.0.1": "2021-10-22", "11.0": "2021-09-20", "10.3.1": "2021-06-16", "10.3": "2020-12-21", "10.2": "2020-07-14", "10.1": "2020-02-19", "10.0": "2019-06-24", "9.3.1": "2019-03-16", "9.3": "2019-01-25", "9.2": "2018-05-26","9.1": "2017-11-26","9.0.1": "2017-11-03","9.0": "2017-07-26","8.0.1": "2017-11-03","8.0": "2016-06-30","7.2.1": "2017-11-03","7.2": "2016-04-05","7.1": "2016-02-07","7.0": "2015-01-11","6.1": "2013-12-13","6.0": "2013-04-23","5.0.3": "2011-07-13","5.0.2": "2011-07-11","5.0.1": "2011-04-18"} )
#foreach( $version in $versions.entrySet() )

| package | link |
Expand Down
1 change: 1 addition & 0 deletions src/site/markdown/faq.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -152,6 +152,7 @@ Math to Hipparchus
Orekit 11.3.1 | Hipparchus 2.3
Orekit 11.3.2 | Hipparchus 2.3
Orekit 11.3.3 | Hipparchus 2.3
Orekit 12.0 | Hipparchus 3.0

### Maven failed to compile Orekit and complained about a missing artifact.

Expand Down
5 changes: 4 additions & 1 deletion src/site/markdown/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,7 @@
* Cartesian, Keplerian (elliptic, parabolic, hyperbolic), circular and equinoctial parameters, with non-Keplerian
derivatives if available
* Two-Line Elements (TLE)
* Two-Line Elements generation using Fixed-Point algorithm or Least Squares Fitting
* transparent conversion between all parameters
* automatic binding with frames
* attitude state and derivative
Expand All @@ -68,6 +69,7 @@
* covariance extrapolation using a Keplerian model
* covariance frame transformation (inertial, Earth fixed, and local orbital frames)
* covariance type transformation (cartesian, keplerian, circular, and equinoctial)
* covariance interpolation based on the blending model

* Maneuvers

Expand Down Expand Up @@ -109,7 +111,7 @@
* semi-analytical propagation model (DSST)
* central attraction
* gravity models
* J2-squared effect
* J2-squared effect (Zeis model)
* atmospheric drag
* third body attraction
* radiation pressure with eclipses
Expand Down Expand Up @@ -292,6 +294,7 @@
* loading of SEM and YUMA files for GPS constellation
* exporting of ephemeris in CCSDS OEM and OCM file formats
* loading of ILRS CPF orbit files
* exporting of ephemeris in STK format

* Earth models

Expand Down

0 comments on commit b3f7ddd

Please sign in to comment.