Skip to content
Snippets Groups Projects
Commit b5a4abbe authored by Luc Maisonobe's avatar Luc Maisonobe
Browse files

Synchronized static site and forge wiki pages.

parent 50e44738
No related branches found
No related tags found
No related merge requests found
......@@ -23,9 +23,9 @@
</question>
<answer>
<p>
Yes, it is used in successful operational missions.
Almost, as it is used in a project under development.
</p>
<p>The first operational use of Rugged was Sentinel 2 ESA mission.
<p>The first operational use of Rugged will be Sentinel 2 ESA mission.
Rugged is used in the Image Processing Facility.
</p>
</answer>
......@@ -36,7 +36,7 @@
</question>
<answer>
<p>
Yes, rugged has been validated, by comparison with other image
Yes, Rugged has been validated, by comparison with other image
processing systems.
</p>
<p>
......
......@@ -92,7 +92,7 @@ The simplest way to use Rugged with Eclipse is to follow these steps:
* set the external libraries to JRE system library (provided by Eclipse),
Junit 4.x (provided by Eclipse), Apache Commons Math (available at
Apache Software Foundation Commons Math
[downloads page](http://commons.apache.org/proper/commons-math/download_math.cgi)),
[downloads page](http://commons.apache.org/proper/commons-math/download_math.cgi),
and Orekit (available at Orekit
[downloads page](https://www.orekit.org/forge/projects/orekit/files))
[downloads page](https://www.orekit.org/forge/projects/orekit/files)
in the libraries tab of the Configure Build Path dialog
<!--- Copyright 2013-2014 CS Systèmes d'Information
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
Configuration
=============
As Rugged relied on Orekit for the frames computation, Orekit
must be properly initialized for Rugged to run.
The simplest way to configure is to first retrieve the example orekit-data.zip
file from Orekit [files](https://www.orekit.org/forge/projects/orekit/files) section
and to unzip it in a known fixed location on your computer (let's assume it is on
your home folder, and it creates an orekit-data subfolder there).
Then near the start of your main program, and before Orekit is called for the
first time, you will add the following code snippet:
File home = new File(System.getProperty("user.home"));
File orekitData = new File(home, "orekit-data");
DataProvidersManager.addProvider(new DirectoryCrawler(orekitData));
This is sufficient to start working.
Note that some of the data in the orekit-data folder needs to be updated,
typically the UTC-TAI.history file, which is updated about once every 18 months
by IERS, and the files in the Earth-Orientation-Parameters folder which are updated
regularly by IERS. The update frequency depends on which file you use.
The data provided in the example archive from Orekit site are example only and are
not kept up to date. The real operational data are live, and remain under the
responsibility of the user.
\ No newline at end of file
......@@ -20,8 +20,8 @@ Mailing lists
Most discussions should occur on the public mailing lists.
|---------------|------------------------------|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
| topic | post address | subscribe URL | archive URL |
|---------------|------------------------------|--------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------|
| announces | orekit-announces@orekit.org | [https://www.orekit.org/wws/subscribe/orekit-announces](https://www.orekit.org/wws/subscribe/orekit-announces) | [https://www.orekit.org/wws/arc/orekit-announces](https://www.orekit.org/wws/arc/orekit-announces) |
| users | orekit-users@orekit.org | [https://www.orekit.org/wws/subscribe/orekit-users](https://www.orekit.org/wws/subscribe/orekit-users) | [https://www.orekit.org/wws/arc/orekit-users](https://www.orekit.org/wws/arc/orekit-users) |
| developers | orekit-developers@orekit.org | [https://www.orekit.org/wws/subscribe/orekit-developers](https://www.orekit.org/wws/subscribe/orekit-developers) | [https://www.orekit.org/wws/arc/orekit-developers](https://www.orekit.org/wws/arc/orekit-developers) |
......@@ -44,13 +44,12 @@ Administrative contact
If you want to discuss with the space division staff at CS Systèmes d'Information,
please use the following address:
|:---------------------------------------------------------------------|
| CS Systèmes d'Information |
| BU E-space & Geoinformation |
| parc de la plaine - 5 rue Brindejonc des Moulinais |
| BP 15872 |
| 31506 Toulouse CEDEX 5 |
| FRANCE |
| |
| phone: +33 5-61-17-66-66 (ask for Luc Maisonobe or Aude Espesset) |
| fax: +33 5-61-34-84-15 |
CS Systèmes d'Information
BU E-space & Geoinformation
parc de la plaine - 5 rue Brindejonc des Moulinais
BP 15872
31506 Toulouse CEDEX 5
FRANCE
phone: +33 5-61-17-66-66 (ask for Luc Maisonobe or Aude Espesset)
fax: +33 5-61-34-84-15
......@@ -96,75 +96,93 @@ configuration. A few of these rules are displayed below. The complete
definition is given by the checkstyle configuration file in the project
root directory.
*header rule*
: all source files start with the Apache license header,
* *header rule*
all source files start with the Apache license header,
*indentation rules*
: no tabs, 4 spaces indentation, no indentation for case statements,
* *indentation rules*
no tabs, 4 spaces indentation, no indentation for case statements,
*operators wrapping rules*
: lines are wrapped after operators (unlike Sun),
* *operators wrapping rules*
lines are wrapped after operators (unlike Sun),
*whitespace rules*
: operators are surrounded by spaces, method parameters open parenthesis
* *whitespace rules*
operators are surrounded by spaces, method parameters open parenthesis
is not preceded by space, lines do not end with white space,
*curly brace rules*
: open curly brace are at end of line, with the matching closing curly brace
* *curly brace rules*
open curly brace are at end of line, with the matching closing curly brace
aligned with the start of the corresponding keyword (_if_, _for_,
_while_, _case_ or _do_),
*encoding rules*
: characters encoding is _UTF8_, the git property _core.autocrlf_ should be
* *encoding rules*
characters encoding is _UTF8_, the git property _core.autocrlf_ should be
set to _input_ on Linux development machines and to _true_ on Windows
development machines (to ensure proper conversion on all operating systems),
*naming rules*
: classes names begin with upper case, instance methods and fields
* *naming rules*
classes names begin with upper case, instance methods and fields
names begin with lower case, class fields are all upper case with
words separated by underscores,
*ordering rules*
: class variables come first, followed by instance variables, followed
* *ordering rules*
class variables come first, followed by instance variables, followed
by constructors, and followed by methods, public modifiers come first,
followed by protected modifiers followed by private modifiers,
*javadoc rules*
: all elements have complete javadoc, even private fields and methods
* *javadoc rules*
all elements have complete javadoc, even private fields and methods
(there are some rare exceptions, in case of code translated from
the fortran language and models with huge parameters sets),
*robustness rules*
: switch/case construct have a default argument, even when all possible
* *robustness rules*
switch/case construct have a default argument, even when all possible
cases are already handled, as many classes as possible are immutable,
*miscellaneous rules*
: _star_ imports are forbidden, parameters and local variables are final
* *miscellaneous rules*
_star_ imports are forbidden, parameters and local variables are final
wherever possible.
Design Rules
------------
*coverage* (validation)
: seek for a line test coverage of at least 80% (more is better)
* *coverage* (validation)
seek for a line test coverage of at least 80% (more is better)
* *findbugs* (robustness)
fix _all_ errors and warnings found by findbugs
*findbugs* (robustness)
: fix _all_ errors and warnings found by findbugs
* *no runtime assumptions* (robustness)
*no runtime assumptions* (robustness)
: do not make assumptions on the runtime environment of applications using Rugged
do not make assumptions on the runtime environment of applications using Orekit
(they may be embedded with no console, no possible user interaction, no network,
no writable file system, no stoppable main program, have memory constraints,
time constraints, be run in different linguistic contexts ...)
*simplicity* (maintainability)
: follow Occam's razor principle or its declination in computer science: KISS (Keep It Simple, Stupid)
* *simplicity* (maintainability)
follow Occam's razor principle or its declination in computer science: KISS (Keep It Simple, Stupid)
* *balanced design* (efficiency)
seek efficiency, but do not overstep robustness and maintainability
* *immutable objects* (robustness, maintainability)
*balanced design* (efficiency)
: seek efficiency, but do not overstep robustness and maintainability
use immutable objects as much as possible
*immutable objects* (robustness, maintainability)
: use immutable objects as much as possible
* *checkstyle* (style)
*checkstyle* (style)
: fix _all_ errors and warnings found by checkstyle
fix _all_ errors and warnings found by checkstyle
......@@ -34,8 +34,8 @@ source code control system. Rugged Git master repository is available online.
tab in Rugged forge
* you can clone it anonymously with the command:
git clone http://www.orekit.org/git/rugged
git clone https://www.orekit.org/git/rugged-main.git
** if you are a committer, you can clone it using your ssh credentials with the command:
git clone ssh://git@www.orekit.org/rugged.git
git clone ssh://git@www.orekit.org/rugged-main.git
......@@ -29,6 +29,7 @@
<item name="Overview" href="/index.html" />
<item name="Getting the sources" href="/sources.html" />
<item name="Building" href="/building.html" />
<item name="Configuration" href="/configuration.html" />
<item name="FAQ" href="/faq.html" />
<item name="License" href="/license.html" />
<item name="Downloads" href="/downloads.html" />
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment