Skip to content

Commit

Permalink
Add license and docs, exported from Codeplex
Browse files Browse the repository at this point in the history
  • Loading branch information
abrudana authored Aug 6, 2017
1 parent 0c6261a commit 92d856f
Show file tree
Hide file tree
Showing 5 changed files with 446 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/Documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
**WWA Documentation**

[Routines](Routines)
[Operations](Operations)

Please note: the C# verions is intended to retain identical functionality to the SOFA library, but made distinct through different function prefixes (**iau** prefix renamed to **wwa**).

For more information please read the SOFA Documentation:
[http://www.iausofa.org/cookbooks.html](http://www.iausofa.org/cookbooks.html)
95 changes: 95 additions & 0 deletions docs/Home.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<div class="wikidoc">
<p><strong>Current WWA Library release based on&nbsp;:&nbsp;<a href="http://www.iausofa.org/current_C.html"> SOFA Library Issue 2017-04-20 for ANSI C</a></strong></p>
<p><strong>Project Description</strong><br>
<br>
World Wide Astronomy - WWA<br>
Set of C# algorithms and procedures that implement standard models used in fundamental astronomy.<br>
Offers more than 160 routines for fundamental astronomy, including time scales (including dealing with leap seconds), Earth rotation, sidereal time, precession, nutation, polar motion, astrometry and transforms between various reference systems (e.g. BCRS,
ICRS, GCRS, CIRS, TIRS, ITRS). The subprograms are supported by 55 vector/matrix routines.<br>
<br>
This program is derived from the <u>International Astronomical Union's</u><br>
<strong>SOFA</strong> (Standards of Fundamental Astronomy) software collection.<br>
<a href="http://www.iausofa.org">http://www.iausofa.org</a><br>
<br>
The WWA code does not itself constitute software provided by and/or endorsed by SOFA.<br>
This version is intended to retain <strong>identical functionality</strong> to the SOFA library, but<br>
made distinct through different function names (prefixes) and C# language specific<br>
modifications in code.<br>
<br>
<strong>Contributor</strong><br>
Attila Abrud&aacute;n</p>
<p>If you make income with the help of this library please donate to the contributor (help to keep up to date the C# version).</p>
<p><strong>SOFA Software License</strong><br>
NOTICE TO USER:<br>
<br>
BY USING THIS SOFTWARE YOU ACCEPT THE FOLLOWING SIX TERMS AND<br>
CONDITIONS WHICH APPLY TO ITS USE.<br>
<br>
1. The Software is owned by the IAU SOFA Board (&quot;SOFA&quot;).<br>
<br>
2. Permission is granted to anyone to use the SOFA software for any<br>
purpose, including commercial applications, free of charge and<br>
without payment of royalties, subject to the conditions and<br>
restrictions listed below.<br>
<br>
3. You (the user) may copy and distribute SOFA source code to others,<br>
and use and adapt its code and algorithms in your own software,<br>
on a world-wide, royalty-free basis. That portion of your<br>
distribution that does not consist of intact and unchanged copies<br>
of SOFA source code files is a &quot;derived work&quot; that must comply<br>
with the following requirements:<br>
<br>
a) Your work shall be marked or carry a statement that it<br>
(i) uses routines and computations derived by you from<br>
software provided by SOFA under license to you; and<br>
(ii) does not itself constitute software provided by and/or<br>
endorsed by SOFA.<br>
<br>
b) The source code of your derived work must contain descriptions<br>
of how the derived work is based upon, contains and/or differs<br>
from the original SOFA software.<br>
<br>
c) The names of all routines in your derived work shall not<br>
include the prefix &quot;iau&quot; or &quot;sofa&quot; or trivial modifications<br>
thereof such as changes of case.<br>
<br>
d) The origin of the SOFA components of your derived work must<br>
not be misrepresented; you must not claim that you wrote the<br>
original software, nor file a patent application for SOFA<br>
software or algorithms embedded in the SOFA software.<br>
<br>
e) These requirements must be reproduced intact in any source<br>
distribution and shall apply to anyone to whom you have<br>
granted a further right to modify the source code of your<br>
derived work.<br>
<br>
Note that, as originally distributed, the SOFA software is<br>
intended to be a definitive implementation of the IAU standards,<br>
and consequently third-party modifications are discouraged. All<br>
variations, no matter how minor, must be explicitly marked as<br>
such, as explained above.<br>
<br>
4. You shall not cause the SOFA software to be brought into<br>
disrepute, either by misuse, or use for inappropriate tasks, or<br>
by inappropriate modification.<br>
<br>
5. The SOFA software is provided &quot;as is&quot; and SOFA makes no warranty<br>
as to its use or performance. SOFA does not and cannot warrant<br>
the performance or results which the user may obtain by using the<br>
SOFA software. SOFA makes no warranties, express or implied, as<br>
to non-infringement of third party rights, merchantability, or<br>
fitness for any particular purpose. In no event will SOFA be<br>
liable to the user for any consequential, incidental, or special<br>
damages, including any lost profits or lost savings, even if a<br>
SOFA representative has been advised of such damages, or for any<br>
claim by any third party.<br>
<br>
6. The provision of any version of the SOFA software under the terms<br>
and conditions specified herein does not imply that future<br>
versions will also be made available under the same terms and<br>
conditions.<br>
<br>
In any published work or commercial product which uses the SOFA<br>
software directly, acknowledgement (see www.iausofa.org) is<br>
appreciated.</p>
</div><div class="ClearBoth"></div>
105 changes: 105 additions & 0 deletions docs/Operations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
**OPERATIONS INVOLVING P-VECTORS AND R-MATRICES**

+Initialize+

ZP zero p-vector
ZR initialize r-matrix to null
IR initialize r-matrix to identity

+Copy/extend/extract+

CP copy p-vector
CR copy r-matrix

+Build rotations+

RX rotate r-matrix about x
RY rotate r-matrix about y
RZ rotate r-matrix about z

+Spherical/Cartesian conversions+

S2C spherical to unit vector
C2S unit vector to spherical
S2P spherical to p-vector
P2S p-vector to spherical

+Operations on vectors+

PPP p-vector plus p-vector
PMP p-vector minus p-vector
PPSP p-vector plus scaled p-vector
PDP inner (=scalar=dot) product of two p-vectors
PXP outer (=vector=cross) product of two p-vectors
PM modulus of p-vector
PN normalize p-vector returning modulus
SXP multiply p-vector by scalar

+Operations on matrices+

RXR r-matrix multiply
TR transpose r-matrix

+Matrix-vector products+

RXP product of r-matrix and p-vector
TRXP product of transpose of r-matrix and p-vector

+Separation and position-angle+

SEPP angular separation from p-vectors
SEPS angular separation from spherical coordinates
PAP position-angle from p-vectors
PAS position-angle from spherical coordinates

+Rotation vectors+

RV2M r-vector to r-matrix
RM2V r-matrix to r-vector


**OPERATIONS INVOLVING PV-VECTORS**

+Initialize+

ZPV zero pv-vector

+Copy/extend/extract+

CPV copy pv-vector
P2PV append zero velocity to p-vector
PV2P discard velocity component of pv-vector

+Spherical/Cartesian conversions+

S2PV spherical to pv-vector
PV2S pv-vector to spherical

+Operations on vectors+

PVPPV pv-vector plus pv-vector
PVMPV pv-vector minus pv-vector
PVDPV inner (=scalar=dot) product of two pv-vectors
PVXPV outer (=vector=cross) product of two pv-vectors
PVM modulus of pv-vector
SXPV multiply pv-vector by scalar
S2XPV multiply pv-vector by two scalars
PVU update pv-vector
PVUP update pv-vector discarding velocity

+Matrix-vector products+

RXPV product of r-matrix and pv-vector
TRXPV product of transpose of r-matrix and pv-vector


**OPERATIONS ON ANGLES**

ANP normalize radians to range 0 to 2pi
ANPM normalize radians to range -pi to +pi
A2TF decompose radians into hours, minutes, seconds
A2AF decompose radians into degrees, arcminutes, arcseconds
AF2A degrees, arcminutes, arcseconds to radians
D2TF decompose days into hours, minutes, seconds
TF2A hours, minutes, seconds to radians
TF2D hours, minutes, seconds to days
Loading

0 comments on commit 92d856f

Please sign in to comment.